<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>pyokx.data_structures &mdash; AntBot 0.0.1 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=d45e8c67"></script>
        <script src="_static/doctools.js?v=888ff710"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="pyokx.low_rest_api.Account" href="pyokx.low_rest_api.Account.html" />
    <link rel="prev" title="pyokx.InstrumentSearcher" href="pyokx.InstrumentSearcher.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html" class="icon icon-home">
            AntBot
          </a>
              <div class="version">
                0.0.1
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="autodocumentation_python.html">autodocumentation_python</a></li>
<li class="toctree-l1"><a class="reference internal" href="firebase_tools.BaseClasses.html">firebase_tools.BaseClasses</a></li>
<li class="toctree-l1"><a class="reference internal" href="firebase_tools.FirestoreClient.html">firebase_tools.FirestoreClient</a></li>
<li class="toctree-l1"><a class="reference internal" href="firebase_tools.authenticate.html">firebase_tools.authenticate</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.dashboard.html">h2o_dashboard.dashboard</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.documentation_page.html">h2o_dashboard.pages.documentation_page</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.okx_dashbaord_page.okx_antbot_okx_premium_indicator_handler.html">h2o_dashboard.pages.okx_dashbaord_page.okx_antbot_okx_premium_indicator_handler</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.okx_dashbaord_page.okx_dashboard_page.html">h2o_dashboard.pages.okx_dashbaord_page.okx_dashboard_page</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.okx_streams.html">h2o_dashboard.pages.okx_streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.pages.overview_page.html">h2o_dashboard.pages.overview_page</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.util.html">h2o_dashboard.util</a></li>
<li class="toctree-l1"><a class="reference internal" href="h2o_dashboard.wave_auth.html">h2o_dashboard.wave_auth</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.Futures_Exchange_Client.html">pyokx.Futures_Exchange_Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.InstrumentSearcher.html">pyokx.InstrumentSearcher</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">pyokx.data_structures</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.adjEq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.adjEq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.borrowFroz"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.borrowFroz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.details"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.details</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.imr"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.imr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.isoEq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.isoEq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.mgnRatio"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.mgnRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.mmr"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.mmr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.model_config"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.notionalUsd"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.notionalUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.ordFroz"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.ordFroz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.totalEq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.totalEq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData.uTime"><code class="docutils literal notranslate"><span class="pre">AccountBalanceData.uTime</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.availBal"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.availBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.availEq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.availEq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.borrowFroz"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.borrowFroz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.cashBal"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.cashBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.ccy"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.crossLiab"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.crossLiab</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.disEq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.disEq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.eq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.eq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.eqUsd"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.eqUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.fixedBal"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.fixedBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.frozenBal"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.frozenBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.interest"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.interest</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.isoEq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.isoEq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.isoLiab"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.isoLiab</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.isoUpl"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.isoUpl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.liab"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.liab</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.maxLoan"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.maxLoan</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.mgnRatio"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.mgnRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.model_config"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.notionalLever"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.notionalLever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.ordFrozen"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.ordFrozen</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.spotInUseAmt"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.spotInUseAmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.spotIsoBal"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.spotIsoBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.stgyEq"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.stgyEq</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.twap"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.twap</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.uTime"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.uTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.upl"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.upl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails.uplLiab"><code class="docutils literal notranslate"><span class="pre">AccountBalanceDetails.uplLiab</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData"><code class="docutils literal notranslate"><span class="pre">AccountConfigData</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.acctLv"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.acctLv</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.autoLoan"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.autoLoan</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.ctIsoMode"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.ctIsoMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.greeksType"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.greeksType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.ip"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.ip</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.kycLv"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.kycLv</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.label"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.label</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.level"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.level</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.levelTmp"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.levelTmp</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.liquidationGear"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.liquidationGear</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.mainUid"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.mainUid</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.mgnIsoMode"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.mgnIsoMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.model_config"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.opAuth"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.opAuth</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.perm"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.perm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.posMode"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.posMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.roleType"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.roleType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.spotOffsetType"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.spotOffsetType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.spotRoleType"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.spotRoleType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.spotTraderInsts"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.spotTraderInsts</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.traderInsts"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.traderInsts</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData.uid"><code class="docutils literal notranslate"><span class="pre">AccountConfigData.uid</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.account_balance"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.account_balance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.account_config"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.account_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.all_algo_orders"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.all_algo_orders</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.all_orders"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.all_orders</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.all_positions"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.all_positions</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.model_config"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.model_fields"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.simplified_balance"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.simplified_balance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.AccountStatusReport.timestamp"><code class="docutils literal notranslate"><span class="pre">AccountStatusReport.timestamp</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Algo_Order"><code class="docutils literal notranslate"><span class="pre">Algo_Order</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.activePx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.activePx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.actualPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.actualPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.actualSide"><code class="docutils literal notranslate"><span class="pre">Algo_Order.actualSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.actualSz"><code class="docutils literal notranslate"><span class="pre">Algo_Order.actualSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.algoClOrdId"><code class="docutils literal notranslate"><span class="pre">Algo_Order.algoClOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.algoId"><code class="docutils literal notranslate"><span class="pre">Algo_Order.algoId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.amendPxOnTriggerType"><code class="docutils literal notranslate"><span class="pre">Algo_Order.amendPxOnTriggerType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.attachAlgoOrds"><code class="docutils literal notranslate"><span class="pre">Algo_Order.attachAlgoOrds</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.cTime"><code class="docutils literal notranslate"><span class="pre">Algo_Order.cTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.callbackRatio"><code class="docutils literal notranslate"><span class="pre">Algo_Order.callbackRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.callbackSpread"><code class="docutils literal notranslate"><span class="pre">Algo_Order.callbackSpread</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.ccy"><code class="docutils literal notranslate"><span class="pre">Algo_Order.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.clOrdId"><code class="docutils literal notranslate"><span class="pre">Algo_Order.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.closeFraction"><code class="docutils literal notranslate"><span class="pre">Algo_Order.closeFraction</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.failCode"><code class="docutils literal notranslate"><span class="pre">Algo_Order.failCode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.instId"><code class="docutils literal notranslate"><span class="pre">Algo_Order.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.instType"><code class="docutils literal notranslate"><span class="pre">Algo_Order.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.last"><code class="docutils literal notranslate"><span class="pre">Algo_Order.last</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.lever"><code class="docutils literal notranslate"><span class="pre">Algo_Order.lever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.model_config"><code class="docutils literal notranslate"><span class="pre">Algo_Order.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.model_fields"><code class="docutils literal notranslate"><span class="pre">Algo_Order.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.moveTriggerPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.moveTriggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.ordId"><code class="docutils literal notranslate"><span class="pre">Algo_Order.ordId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.ordIdList"><code class="docutils literal notranslate"><span class="pre">Algo_Order.ordIdList</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.ordPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.ordPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.ordType"><code class="docutils literal notranslate"><span class="pre">Algo_Order.ordType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.posSide"><code class="docutils literal notranslate"><span class="pre">Algo_Order.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.pxLimit"><code class="docutils literal notranslate"><span class="pre">Algo_Order.pxLimit</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.pxSpread"><code class="docutils literal notranslate"><span class="pre">Algo_Order.pxSpread</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.pxVar"><code class="docutils literal notranslate"><span class="pre">Algo_Order.pxVar</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.quickMgnType"><code class="docutils literal notranslate"><span class="pre">Algo_Order.quickMgnType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.reduceOnly"><code class="docutils literal notranslate"><span class="pre">Algo_Order.reduceOnly</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.side"><code class="docutils literal notranslate"><span class="pre">Algo_Order.side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.slOrdPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.slOrdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.slTriggerPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.slTriggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.slTriggerPxType"><code class="docutils literal notranslate"><span class="pre">Algo_Order.slTriggerPxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.state"><code class="docutils literal notranslate"><span class="pre">Algo_Order.state</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.sz"><code class="docutils literal notranslate"><span class="pre">Algo_Order.sz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.szLimit"><code class="docutils literal notranslate"><span class="pre">Algo_Order.szLimit</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.tag"><code class="docutils literal notranslate"><span class="pre">Algo_Order.tag</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.tdMode"><code class="docutils literal notranslate"><span class="pre">Algo_Order.tdMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.tgtCcy"><code class="docutils literal notranslate"><span class="pre">Algo_Order.tgtCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.timeInterval"><code class="docutils literal notranslate"><span class="pre">Algo_Order.timeInterval</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.tpOrdPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.tpOrdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.tpTriggerPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.tpTriggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.tpTriggerPxType"><code class="docutils literal notranslate"><span class="pre">Algo_Order.tpTriggerPxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.triggerPx"><code class="docutils literal notranslate"><span class="pre">Algo_Order.triggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.triggerPxType"><code class="docutils literal notranslate"><span class="pre">Algo_Order.triggerPxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order.triggerTime"><code class="docutils literal notranslate"><span class="pre">Algo_Order.triggerTime</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.algoClOrdId"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.algoClOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.algoId"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.algoId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.clOrdId"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.model_config"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.model_fields"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.sCode"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.sCode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.sMsg"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.sMsg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Algo_Order_Placement_Return.tag"><code class="docutils literal notranslate"><span class="pre">Algo_Order_Placement_Return.tag</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Ask"><code class="docutils literal notranslate"><span class="pre">Ask</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ask.deprecated_value"><code class="docutils literal notranslate"><span class="pre">Ask.deprecated_value</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ask.model_config"><code class="docutils literal notranslate"><span class="pre">Ask.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ask.model_fields"><code class="docutils literal notranslate"><span class="pre">Ask.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ask.number_of_orders"><code class="docutils literal notranslate"><span class="pre">Ask.number_of_orders</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ask.price"><code class="docutils literal notranslate"><span class="pre">Ask.price</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ask.quantity"><code class="docutils literal notranslate"><span class="pre">Ask.quantity</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Bid"><code class="docutils literal notranslate"><span class="pre">Bid</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Bid.deprecated_value"><code class="docutils literal notranslate"><span class="pre">Bid.deprecated_value</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Bid.model_config"><code class="docutils literal notranslate"><span class="pre">Bid.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Bid.model_fields"><code class="docutils literal notranslate"><span class="pre">Bid.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Bid.number_of_orders"><code class="docutils literal notranslate"><span class="pre">Bid.number_of_orders</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Bid.price"><code class="docutils literal notranslate"><span class="pre">Bid.price</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Bid.quantity"><code class="docutils literal notranslate"><span class="pre">Bid.quantity</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.algoClOrdId"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.algoClOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.algoId"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.algoId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.clOrdId"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.model_config"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.model_fields"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.sCode"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.sCode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.sMsg"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.sMsg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Algo_Order.tag"><code class="docutils literal notranslate"><span class="pre">Cancelled_Algo_Order.tag</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Order"><code class="docutils literal notranslate"><span class="pre">Cancelled_Order</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Order.clOrdId"><code class="docutils literal notranslate"><span class="pre">Cancelled_Order.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Order.model_config"><code class="docutils literal notranslate"><span class="pre">Cancelled_Order.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Order.model_fields"><code class="docutils literal notranslate"><span class="pre">Cancelled_Order.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Order.ordId"><code class="docutils literal notranslate"><span class="pre">Cancelled_Order.ordId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Order.sCode"><code class="docutils literal notranslate"><span class="pre">Cancelled_Order.sCode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Cancelled_Order.sMsg"><code class="docutils literal notranslate"><span class="pre">Cancelled_Order.sMsg</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Closed_Position"><code class="docutils literal notranslate"><span class="pre">Closed_Position</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Closed_Position.clOrdId"><code class="docutils literal notranslate"><span class="pre">Closed_Position.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Closed_Position.instId"><code class="docutils literal notranslate"><span class="pre">Closed_Position.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Closed_Position.model_config"><code class="docutils literal notranslate"><span class="pre">Closed_Position.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Closed_Position.model_fields"><code class="docutils literal notranslate"><span class="pre">Closed_Position.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Closed_Position.posSide"><code class="docutils literal notranslate"><span class="pre">Closed_Position.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Closed_Position.tag"><code class="docutils literal notranslate"><span class="pre">Closed_Position.tag</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.execution_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.execution_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.model_config"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.model_fields"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.order_side"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.order_side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.order_type"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.order_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.sl_execution_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.sl_execution_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.sl_trigger_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.sl_trigger_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.sl_trigger_price_type"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.sl_trigger_price_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.tp_execution_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.tp_execution_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.tp_trigger_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.tp_trigger_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.tp_trigger_price_type"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.tp_trigger_price_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.trigger_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.trigger_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters.usd_amount"><code class="docutils literal notranslate"><span class="pre">DCAInputParameters.usd_amount</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.execution_price"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.execution_price</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.model_config"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.model_fields"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.side"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.size"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.size</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.sl_execution_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.sl_execution_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.sl_trigger_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.sl_trigger_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.sl_trigger_price_type"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.sl_trigger_price_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.tp_execution_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.tp_execution_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.tp_trigger_price_offset"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.tp_trigger_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.tp_trigger_price_type"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.tp_trigger_price_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.trigger_price"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.trigger_price</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.DCAOrderParameters.type"><code class="docutils literal notranslate"><span class="pre">DCAOrderParameters.type</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.FillEntry"><code class="docutils literal notranslate"><span class="pre">FillEntry</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.billId"><code class="docutils literal notranslate"><span class="pre">FillEntry.billId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.clOrdId"><code class="docutils literal notranslate"><span class="pre">FillEntry.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.execType"><code class="docutils literal notranslate"><span class="pre">FillEntry.execType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fee"><code class="docutils literal notranslate"><span class="pre">FillEntry.fee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.feeCcy"><code class="docutils literal notranslate"><span class="pre">FillEntry.feeCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillFwdPx"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillFwdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillIdxPx"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillIdxPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillMarkPx"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillMarkPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillMarkVol"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillMarkVol</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillPnl"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillPnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillPx"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillPxUsd"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillPxUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillPxVol"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillPxVol</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillSz"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.fillTime"><code class="docutils literal notranslate"><span class="pre">FillEntry.fillTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.instId"><code class="docutils literal notranslate"><span class="pre">FillEntry.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.instType"><code class="docutils literal notranslate"><span class="pre">FillEntry.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.model_config"><code class="docutils literal notranslate"><span class="pre">FillEntry.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.model_fields"><code class="docutils literal notranslate"><span class="pre">FillEntry.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.ordId"><code class="docutils literal notranslate"><span class="pre">FillEntry.ordId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.posSide"><code class="docutils literal notranslate"><span class="pre">FillEntry.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.side"><code class="docutils literal notranslate"><span class="pre">FillEntry.side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.tag"><code class="docutils literal notranslate"><span class="pre">FillEntry.tag</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.tradeId"><code class="docutils literal notranslate"><span class="pre">FillEntry.tradeId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillEntry.ts"><code class="docutils literal notranslate"><span class="pre">FillEntry.ts</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetrics"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetrics</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetrics.ONE_DAY"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetrics.ONE_DAY</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetrics.ONE_MONTH"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetrics.ONE_MONTH</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetrics.ONE_WEEK"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetrics.ONE_WEEK</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetrics.THREE_MONTHS"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetrics.THREE_MONTHS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetrics.model_config"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetrics.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetrics.model_fields"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetrics.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetricsEntry</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry.avg_fill_pnl"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetricsEntry.avg_fill_pnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry.model_config"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetricsEntry.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry.model_fields"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetricsEntry.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry.total_fill_fee"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetricsEntry.total_fill_fee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry.total_fill_pnl"><code class="docutils literal notranslate"><span class="pre">FillHistoricalMetricsEntry.total_fill_pnl</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.InstIdSignalRequestForm"><code class="docutils literal notranslate"><span class="pre">InstIdSignalRequestForm</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstIdSignalRequestForm.InstIdAPIKey"><code class="docutils literal notranslate"><span class="pre">InstIdSignalRequestForm.InstIdAPIKey</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstIdSignalRequestForm.OKXSignalInput"><code class="docutils literal notranslate"><span class="pre">InstIdSignalRequestForm.OKXSignalInput</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstIdSignalRequestForm.model_config"><code class="docutils literal notranslate"><span class="pre">InstIdSignalRequestForm.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstIdSignalRequestForm.model_fields"><code class="docutils literal notranslate"><span class="pre">InstIdSignalRequestForm.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Instrument"><code class="docutils literal notranslate"><span class="pre">Instrument</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.alias"><code class="docutils literal notranslate"><span class="pre">Instrument.alias</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.baseCcy"><code class="docutils literal notranslate"><span class="pre">Instrument.baseCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.category"><code class="docutils literal notranslate"><span class="pre">Instrument.category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.ctMult"><code class="docutils literal notranslate"><span class="pre">Instrument.ctMult</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.ctType"><code class="docutils literal notranslate"><span class="pre">Instrument.ctType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.ctVal"><code class="docutils literal notranslate"><span class="pre">Instrument.ctVal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.ctValCcy"><code class="docutils literal notranslate"><span class="pre">Instrument.ctValCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.expTime"><code class="docutils literal notranslate"><span class="pre">Instrument.expTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.instFamily"><code class="docutils literal notranslate"><span class="pre">Instrument.instFamily</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.instId"><code class="docutils literal notranslate"><span class="pre">Instrument.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.instType"><code class="docutils literal notranslate"><span class="pre">Instrument.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.lever"><code class="docutils literal notranslate"><span class="pre">Instrument.lever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.listTime"><code class="docutils literal notranslate"><span class="pre">Instrument.listTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.lotSz"><code class="docutils literal notranslate"><span class="pre">Instrument.lotSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxIcebergSz"><code class="docutils literal notranslate"><span class="pre">Instrument.maxIcebergSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxLmtAmt"><code class="docutils literal notranslate"><span class="pre">Instrument.maxLmtAmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxLmtSz"><code class="docutils literal notranslate"><span class="pre">Instrument.maxLmtSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxMktAmt"><code class="docutils literal notranslate"><span class="pre">Instrument.maxMktAmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxMktSz"><code class="docutils literal notranslate"><span class="pre">Instrument.maxMktSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxStopSz"><code class="docutils literal notranslate"><span class="pre">Instrument.maxStopSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxTriggerSz"><code class="docutils literal notranslate"><span class="pre">Instrument.maxTriggerSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.maxTwapSz"><code class="docutils literal notranslate"><span class="pre">Instrument.maxTwapSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.minSz"><code class="docutils literal notranslate"><span class="pre">Instrument.minSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.model_config"><code class="docutils literal notranslate"><span class="pre">Instrument.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.model_fields"><code class="docutils literal notranslate"><span class="pre">Instrument.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.optType"><code class="docutils literal notranslate"><span class="pre">Instrument.optType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.quoteCcy"><code class="docutils literal notranslate"><span class="pre">Instrument.quoteCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.settleCcy"><code class="docutils literal notranslate"><span class="pre">Instrument.settleCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.state"><code class="docutils literal notranslate"><span class="pre">Instrument.state</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.stk"><code class="docutils literal notranslate"><span class="pre">Instrument.stk</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.tickSz"><code class="docutils literal notranslate"><span class="pre">Instrument.tickSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Instrument.uly"><code class="docutils literal notranslate"><span class="pre">Instrument.uly</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.algo_orders"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.algo_orders</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.instId"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.max_avail_size"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.max_avail_size</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.max_order_size"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.max_order_size</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.model_config"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.model_fields"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.orders"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.orders</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.positions"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.positions</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.InstrumentStatusReport.timestamp"><code class="docutils literal notranslate"><span class="pre">InstrumentStatusReport.timestamp</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData"><code class="docutils literal notranslate"><span class="pre">MaxAvailSizeData</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData.availBuy"><code class="docutils literal notranslate"><span class="pre">MaxAvailSizeData.availBuy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData.availSell"><code class="docutils literal notranslate"><span class="pre">MaxAvailSizeData.availSell</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData.instId"><code class="docutils literal notranslate"><span class="pre">MaxAvailSizeData.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData.model_config"><code class="docutils literal notranslate"><span class="pre">MaxAvailSizeData.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData.model_fields"><code class="docutils literal notranslate"><span class="pre">MaxAvailSizeData.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData"><code class="docutils literal notranslate"><span class="pre">MaxOrderSizeData</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData.ccy"><code class="docutils literal notranslate"><span class="pre">MaxOrderSizeData.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData.instId"><code class="docutils literal notranslate"><span class="pre">MaxOrderSizeData.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData.maxBuy"><code class="docutils literal notranslate"><span class="pre">MaxOrderSizeData.maxBuy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData.maxSell"><code class="docutils literal notranslate"><span class="pre">MaxOrderSizeData.maxSell</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData.model_config"><code class="docutils literal notranslate"><span class="pre">MaxOrderSizeData.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData.model_fields"><code class="docutils literal notranslate"><span class="pre">MaxOrderSizeData.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.OKXBaseModel"><code class="docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXBaseModel.model_config"><code class="docutils literal notranslate"><span class="pre">OKXBaseModel.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXBaseModel.model_fields"><code class="docutils literal notranslate"><span class="pre">OKXBaseModel.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.OKXBaseModelModelMeta"><code class="docutils literal notranslate"><span class="pre">OKXBaseModelModelMeta</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm"><code class="docutils literal notranslate"><span class="pre">OKXPremiumIndicatorSignalRequestForm</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.InstIdAPIKey"><code class="docutils literal notranslate"><span class="pre">OKXPremiumIndicatorSignalRequestForm.InstIdAPIKey</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.OKXSignalInput"><code class="docutils literal notranslate"><span class="pre">OKXPremiumIndicatorSignalRequestForm.OKXSignalInput</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.PremiumIndicatorSignals"><code class="docutils literal notranslate"><span class="pre">OKXPremiumIndicatorSignalRequestForm.PremiumIndicatorSignals</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.model_config"><code class="docutils literal notranslate"><span class="pre">OKXPremiumIndicatorSignalRequestForm.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.model_fields"><code class="docutils literal notranslate"><span class="pre">OKXPremiumIndicatorSignalRequestForm.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.to_tradingview_json_payload"><code class="docutils literal notranslate"><span class="pre">OKXPremiumIndicatorSignalRequestForm.to_tradingview_json_payload()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.clear_prior_to_new_order"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.clear_prior_to_new_order</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.dca_parameters"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.dca_parameters</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.flip_position_if_opposite_side"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.flip_position_if_opposite_side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.instID"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.instID</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.leverage"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.leverage</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.max_orderbook_limit_price_offset"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.max_orderbook_limit_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.model_config"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.model_fields"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.order_side"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.order_side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.order_type"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.order_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.red_button"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.red_button</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.sl_execution_price_offset"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.sl_execution_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.sl_trigger_price_offset"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.sl_trigger_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.sl_trigger_price_type"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.sl_trigger_price_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.tp_execution_price_offset"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.tp_execution_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.tp_trigger_price_offset"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.tp_trigger_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.tp_trigger_price_type"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.tp_trigger_price_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.trailing_stop_activation_price_offset"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.trailing_stop_activation_price_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.trailing_stop_callback_offset"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.trailing_stop_callback_offset</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput.usd_order_size"><code class="docutils literal notranslate"><span class="pre">OKXSignalInput.usd_order_size</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Order"><code class="docutils literal notranslate"><span class="pre">Order</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.accFillSz"><code class="docutils literal notranslate"><span class="pre">Order.accFillSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.algoClOrdId"><code class="docutils literal notranslate"><span class="pre">Order.algoClOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.algoId"><code class="docutils literal notranslate"><span class="pre">Order.algoId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.attachAlgoClOrdId"><code class="docutils literal notranslate"><span class="pre">Order.attachAlgoClOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.attachAlgoOrds"><code class="docutils literal notranslate"><span class="pre">Order.attachAlgoOrds</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.avgPx"><code class="docutils literal notranslate"><span class="pre">Order.avgPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.cTime"><code class="docutils literal notranslate"><span class="pre">Order.cTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.cancelSource"><code class="docutils literal notranslate"><span class="pre">Order.cancelSource</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.cancelSourceReason"><code class="docutils literal notranslate"><span class="pre">Order.cancelSourceReason</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.category"><code class="docutils literal notranslate"><span class="pre">Order.category</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.ccy"><code class="docutils literal notranslate"><span class="pre">Order.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.clOrdId"><code class="docutils literal notranslate"><span class="pre">Order.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.fee"><code class="docutils literal notranslate"><span class="pre">Order.fee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.feeCcy"><code class="docutils literal notranslate"><span class="pre">Order.feeCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.fillPx"><code class="docutils literal notranslate"><span class="pre">Order.fillPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.fillSz"><code class="docutils literal notranslate"><span class="pre">Order.fillSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.fillTime"><code class="docutils literal notranslate"><span class="pre">Order.fillTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.instId"><code class="docutils literal notranslate"><span class="pre">Order.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.instType"><code class="docutils literal notranslate"><span class="pre">Order.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.lever"><code class="docutils literal notranslate"><span class="pre">Order.lever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.model_config"><code class="docutils literal notranslate"><span class="pre">Order.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.model_fields"><code class="docutils literal notranslate"><span class="pre">Order.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.ordId"><code class="docutils literal notranslate"><span class="pre">Order.ordId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.ordType"><code class="docutils literal notranslate"><span class="pre">Order.ordType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.pnl"><code class="docutils literal notranslate"><span class="pre">Order.pnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.posSide"><code class="docutils literal notranslate"><span class="pre">Order.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.px"><code class="docutils literal notranslate"><span class="pre">Order.px</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.pxType"><code class="docutils literal notranslate"><span class="pre">Order.pxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.pxUsd"><code class="docutils literal notranslate"><span class="pre">Order.pxUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.pxVol"><code class="docutils literal notranslate"><span class="pre">Order.pxVol</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.quickMgnType"><code class="docutils literal notranslate"><span class="pre">Order.quickMgnType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.rebate"><code class="docutils literal notranslate"><span class="pre">Order.rebate</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.rebateCcy"><code class="docutils literal notranslate"><span class="pre">Order.rebateCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.reduceOnly"><code class="docutils literal notranslate"><span class="pre">Order.reduceOnly</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.side"><code class="docutils literal notranslate"><span class="pre">Order.side</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.slOrdPx"><code class="docutils literal notranslate"><span class="pre">Order.slOrdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.slTriggerPx"><code class="docutils literal notranslate"><span class="pre">Order.slTriggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.slTriggerPxType"><code class="docutils literal notranslate"><span class="pre">Order.slTriggerPxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.source"><code class="docutils literal notranslate"><span class="pre">Order.source</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.state"><code class="docutils literal notranslate"><span class="pre">Order.state</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.stpId"><code class="docutils literal notranslate"><span class="pre">Order.stpId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.stpMode"><code class="docutils literal notranslate"><span class="pre">Order.stpMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.sz"><code class="docutils literal notranslate"><span class="pre">Order.sz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.tag"><code class="docutils literal notranslate"><span class="pre">Order.tag</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.tdMode"><code class="docutils literal notranslate"><span class="pre">Order.tdMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.tgtCcy"><code class="docutils literal notranslate"><span class="pre">Order.tgtCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.tpOrdPx"><code class="docutils literal notranslate"><span class="pre">Order.tpOrdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.tpTriggerPx"><code class="docutils literal notranslate"><span class="pre">Order.tpTriggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.tpTriggerPxType"><code class="docutils literal notranslate"><span class="pre">Order.tpTriggerPxType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.tradeId"><code class="docutils literal notranslate"><span class="pre">Order.tradeId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order.uTime"><code class="docutils literal notranslate"><span class="pre">Order.uTime</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return.clOrdId"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return.clOrdId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return.model_config"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return.model_fields"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return.ordId"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return.ordId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return.sCode"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return.sCode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return.sMsg"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return.sMsg</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Order_Placement_Return.tag"><code class="docutils literal notranslate"><span class="pre">Order_Placement_Return.tag</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot.asks"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot.asks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot.bids"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot.bids</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot.depth"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot.depth</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot.instId"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot.model_config"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot.model_fields"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Orderbook_Snapshot.ts"><code class="docutils literal notranslate"><span class="pre">Orderbook_Snapshot.ts</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Position"><code class="docutils literal notranslate"><span class="pre">Position</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.adl"><code class="docutils literal notranslate"><span class="pre">Position.adl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.availPos"><code class="docutils literal notranslate"><span class="pre">Position.availPos</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.avgPx"><code class="docutils literal notranslate"><span class="pre">Position.avgPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.baseBal"><code class="docutils literal notranslate"><span class="pre">Position.baseBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.baseBorrowed"><code class="docutils literal notranslate"><span class="pre">Position.baseBorrowed</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.baseInterest"><code class="docutils literal notranslate"><span class="pre">Position.baseInterest</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.bePx"><code class="docutils literal notranslate"><span class="pre">Position.bePx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.bizRefId"><code class="docutils literal notranslate"><span class="pre">Position.bizRefId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.bizRefType"><code class="docutils literal notranslate"><span class="pre">Position.bizRefType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.cTime"><code class="docutils literal notranslate"><span class="pre">Position.cTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.ccy"><code class="docutils literal notranslate"><span class="pre">Position.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.closeOrderAlgo"><code class="docutils literal notranslate"><span class="pre">Position.closeOrderAlgo</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.deltaBS"><code class="docutils literal notranslate"><span class="pre">Position.deltaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.deltaPA"><code class="docutils literal notranslate"><span class="pre">Position.deltaPA</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.fee"><code class="docutils literal notranslate"><span class="pre">Position.fee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.fundingFee"><code class="docutils literal notranslate"><span class="pre">Position.fundingFee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.gammaBS"><code class="docutils literal notranslate"><span class="pre">Position.gammaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.gammaPA"><code class="docutils literal notranslate"><span class="pre">Position.gammaPA</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.idxPx"><code class="docutils literal notranslate"><span class="pre">Position.idxPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.imr"><code class="docutils literal notranslate"><span class="pre">Position.imr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.instId"><code class="docutils literal notranslate"><span class="pre">Position.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.instType"><code class="docutils literal notranslate"><span class="pre">Position.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.interest"><code class="docutils literal notranslate"><span class="pre">Position.interest</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.last"><code class="docutils literal notranslate"><span class="pre">Position.last</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.lever"><code class="docutils literal notranslate"><span class="pre">Position.lever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.liab"><code class="docutils literal notranslate"><span class="pre">Position.liab</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.liabCcy"><code class="docutils literal notranslate"><span class="pre">Position.liabCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.liqPenalty"><code class="docutils literal notranslate"><span class="pre">Position.liqPenalty</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.liqPx"><code class="docutils literal notranslate"><span class="pre">Position.liqPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.margin"><code class="docutils literal notranslate"><span class="pre">Position.margin</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.markPx"><code class="docutils literal notranslate"><span class="pre">Position.markPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.mgnMode"><code class="docutils literal notranslate"><span class="pre">Position.mgnMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.mgnRatio"><code class="docutils literal notranslate"><span class="pre">Position.mgnRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.mmr"><code class="docutils literal notranslate"><span class="pre">Position.mmr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.model_config"><code class="docutils literal notranslate"><span class="pre">Position.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.model_fields"><code class="docutils literal notranslate"><span class="pre">Position.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.notionalUsd"><code class="docutils literal notranslate"><span class="pre">Position.notionalUsd</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.optVal"><code class="docutils literal notranslate"><span class="pre">Position.optVal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.pendingCloseOrdLiabVal"><code class="docutils literal notranslate"><span class="pre">Position.pendingCloseOrdLiabVal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.pnl"><code class="docutils literal notranslate"><span class="pre">Position.pnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.pos"><code class="docutils literal notranslate"><span class="pre">Position.pos</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.posCcy"><code class="docutils literal notranslate"><span class="pre">Position.posCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.posId"><code class="docutils literal notranslate"><span class="pre">Position.posId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.posSide"><code class="docutils literal notranslate"><span class="pre">Position.posSide</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.quoteBal"><code class="docutils literal notranslate"><span class="pre">Position.quoteBal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.quoteBorrowed"><code class="docutils literal notranslate"><span class="pre">Position.quoteBorrowed</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.quoteInterest"><code class="docutils literal notranslate"><span class="pre">Position.quoteInterest</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.realizedPnl"><code class="docutils literal notranslate"><span class="pre">Position.realizedPnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.spotInUseAmt"><code class="docutils literal notranslate"><span class="pre">Position.spotInUseAmt</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.spotInUseCcy"><code class="docutils literal notranslate"><span class="pre">Position.spotInUseCcy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.thetaBS"><code class="docutils literal notranslate"><span class="pre">Position.thetaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.thetaPA"><code class="docutils literal notranslate"><span class="pre">Position.thetaPA</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.tradeId"><code class="docutils literal notranslate"><span class="pre">Position.tradeId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.uTime"><code class="docutils literal notranslate"><span class="pre">Position.uTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.upl"><code class="docutils literal notranslate"><span class="pre">Position.upl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.uplLastPx"><code class="docutils literal notranslate"><span class="pre">Position.uplLastPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.uplRatio"><code class="docutils literal notranslate"><span class="pre">Position.uplRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.uplRatioLastPx"><code class="docutils literal notranslate"><span class="pre">Position.uplRatioLastPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.usdPx"><code class="docutils literal notranslate"><span class="pre">Position.usdPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.vegaBS"><code class="docutils literal notranslate"><span class="pre">Position.vegaBS</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Position.vegaPA"><code class="docutils literal notranslate"><span class="pre">Position.vegaPA</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.PositionHistory"><code class="docutils literal notranslate"><span class="pre">PositionHistory</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.Config"><code class="docutils literal notranslate"><span class="pre">PositionHistory.Config</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.Config.use_enum_values"><code class="docutils literal notranslate"><span class="pre">PositionHistory.Config.use_enum_values</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.cTime"><code class="docutils literal notranslate"><span class="pre">PositionHistory.cTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.ccy"><code class="docutils literal notranslate"><span class="pre">PositionHistory.ccy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.closeAvgPx"><code class="docutils literal notranslate"><span class="pre">PositionHistory.closeAvgPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.closeTotalPos"><code class="docutils literal notranslate"><span class="pre">PositionHistory.closeTotalPos</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.direction"><code class="docutils literal notranslate"><span class="pre">PositionHistory.direction</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.fee"><code class="docutils literal notranslate"><span class="pre">PositionHistory.fee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.fundingFee"><code class="docutils literal notranslate"><span class="pre">PositionHistory.fundingFee</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.handle_triggerPx"><code class="docutils literal notranslate"><span class="pre">PositionHistory.handle_triggerPx()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.instId"><code class="docutils literal notranslate"><span class="pre">PositionHistory.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.instType"><code class="docutils literal notranslate"><span class="pre">PositionHistory.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.lever"><code class="docutils literal notranslate"><span class="pre">PositionHistory.lever</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.liqPenalty"><code class="docutils literal notranslate"><span class="pre">PositionHistory.liqPenalty</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.mgnMode"><code class="docutils literal notranslate"><span class="pre">PositionHistory.mgnMode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.model_config"><code class="docutils literal notranslate"><span class="pre">PositionHistory.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.model_fields"><code class="docutils literal notranslate"><span class="pre">PositionHistory.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.openAvgPx"><code class="docutils literal notranslate"><span class="pre">PositionHistory.openAvgPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.openMaxPos"><code class="docutils literal notranslate"><span class="pre">PositionHistory.openMaxPos</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.pnl"><code class="docutils literal notranslate"><span class="pre">PositionHistory.pnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.pnlRatio"><code class="docutils literal notranslate"><span class="pre">PositionHistory.pnlRatio</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.posId"><code class="docutils literal notranslate"><span class="pre">PositionHistory.posId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.realizedPnl"><code class="docutils literal notranslate"><span class="pre">PositionHistory.realizedPnl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.triggerPx"><code class="docutils literal notranslate"><span class="pre">PositionHistory.triggerPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.type"><code class="docutils literal notranslate"><span class="pre">PositionHistory.type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.uTime"><code class="docutils literal notranslate"><span class="pre">PositionHistory.uTime</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PositionHistory.uly"><code class="docutils literal notranslate"><span class="pre">PositionHistory.uly</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.Bearish"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.Bearish</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.Bearish_Exit"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.Bearish_Exit</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.Bearish_plus"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.Bearish_plus</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.Bullish"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.Bullish</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.Bullish_Exit"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.Bullish_Exit</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.Bullish_plus"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.Bullish_plus</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.model_config"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.model_fields"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals.tradingview_json_payload"><code class="docutils literal notranslate"><span class="pre">PremiumIndicatorSignals.tradingview_json_payload()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details.Available_Balance"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details.Available_Balance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details.Currency"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details.Currency</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details.Equity"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details.Equity</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details.Equity_in_USD"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details.Equity_in_USD</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details.Frozen_Balance"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details.Frozen_Balance</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details.model_config"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details.model_fields"><code class="docutils literal notranslate"><span class="pre">Simplified_Balance_Details.model_fields</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#pyokx.data_structures.Ticker"><code class="docutils literal notranslate"><span class="pre">Ticker</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.askPx"><code class="docutils literal notranslate"><span class="pre">Ticker.askPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.askSz"><code class="docutils literal notranslate"><span class="pre">Ticker.askSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.bidPx"><code class="docutils literal notranslate"><span class="pre">Ticker.bidPx</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.bidSz"><code class="docutils literal notranslate"><span class="pre">Ticker.bidSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.high24h"><code class="docutils literal notranslate"><span class="pre">Ticker.high24h</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.instId"><code class="docutils literal notranslate"><span class="pre">Ticker.instId</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.instType"><code class="docutils literal notranslate"><span class="pre">Ticker.instType</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.last"><code class="docutils literal notranslate"><span class="pre">Ticker.last</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.lastSz"><code class="docutils literal notranslate"><span class="pre">Ticker.lastSz</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.low24h"><code class="docutils literal notranslate"><span class="pre">Ticker.low24h</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.model_config"><code class="docutils literal notranslate"><span class="pre">Ticker.model_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.model_fields"><code class="docutils literal notranslate"><span class="pre">Ticker.model_fields</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.open24h"><code class="docutils literal notranslate"><span class="pre">Ticker.open24h</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.sodUtc0"><code class="docutils literal notranslate"><span class="pre">Ticker.sodUtc0</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.sodUtc8"><code class="docutils literal notranslate"><span class="pre">Ticker.sodUtc8</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.ts"><code class="docutils literal notranslate"><span class="pre">Ticker.ts</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.vol24h"><code class="docutils literal notranslate"><span class="pre">Ticker.vol24h</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#pyokx.data_structures.Ticker.volCcy24h"><code class="docutils literal notranslate"><span class="pre">Ticker.volCcy24h</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Account.html">pyokx.low_rest_api.Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.BlockTrading.html">pyokx.low_rest_api.BlockTrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Convert.html">pyokx.low_rest_api.Convert</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.CopyTrading.html">pyokx.low_rest_api.CopyTrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Earning.html">pyokx.low_rest_api.Earning</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.FDBroker.html">pyokx.low_rest_api.FDBroker</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Funding.html">pyokx.low_rest_api.Funding</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Grid.html">pyokx.low_rest_api.Grid</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.MarketData.html">pyokx.low_rest_api.MarketData</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.NDBroker.html">pyokx.low_rest_api.NDBroker</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.PublicData.html">pyokx.low_rest_api.PublicData</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.SpreadTrading.html">pyokx.low_rest_api.SpreadTrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Status.html">pyokx.low_rest_api.Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.SubAccount.html">pyokx.low_rest_api.SubAccount</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.Trade.html">pyokx.low_rest_api.Trade</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.TradingData.html">pyokx.low_rest_api.TradingData</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.client.html">pyokx.low_rest_api.client</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.consts.html">pyokx.low_rest_api.consts</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.exceptions.html">pyokx.low_rest_api.exceptions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.low_rest_api.utils.html">pyokx.low_rest_api.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.WssMarketDataService.html">pyokx.okx_market_maker.market_data_service.WssMarketDataService</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.Instrument.html">pyokx.okx_market_maker.market_data_service.model.Instrument</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.MarkPx.html">pyokx.okx_market_maker.market_data_service.model.MarkPx</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.OrderBook.html">pyokx.okx_market_maker.market_data_service.model.OrderBook</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.market_data_service.model.Tickers.html">pyokx.okx_market_maker.market_data_service.model.Tickers</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.order_management_service.WssOrderManagementService.html">pyokx.okx_market_maker.order_management_service.WssOrderManagementService</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.order_management_service.model.Order.html">pyokx.okx_market_maker.order_management_service.model.Order</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.order_management_service.model.OrderRequest.html">pyokx.okx_market_maker.order_management_service.model.OrderRequest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.WssPositionManagementService.html">pyokx.okx_market_maker.position_management_service.WssPositionManagementService</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.model.Account.html">pyokx.okx_market_maker.position_management_service.model.Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.model.BalanceAndPosition.html">pyokx.okx_market_maker.position_management_service.model.BalanceAndPosition</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.position_management_service.model.Positions.html">pyokx.okx_market_maker.position_management_service.model.Positions</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.run_sample_market_maker.html">pyokx.okx_market_maker.run_sample_market_maker</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.settings.html">pyokx.okx_market_maker.settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.BaseStrategy.html">pyokx.okx_market_maker.strategy.BaseStrategy</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.SampleMM.html">pyokx.okx_market_maker.strategy.SampleMM</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.model.StrategyMeasurement.html">pyokx.okx_market_maker.strategy.model.StrategyMeasurement</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.model.StrategyOrder.html">pyokx.okx_market_maker.strategy.model.StrategyOrder</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.params.ParamsLoader.html">pyokx.okx_market_maker.strategy.params.ParamsLoader</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.risk.RiskCalculator.html">pyokx.okx_market_maker.strategy.risk.RiskCalculator</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.strategy.risk.RiskSnapshot.html">pyokx.okx_market_maker.strategy.risk.RiskSnapshot</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.tests.test_strategy.html">pyokx.okx_market_maker.tests.test_strategy</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.InstrumentUtil.html">pyokx.okx_market_maker.utils.InstrumentUtil</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html">pyokx.okx_market_maker.utils.OkxEnum</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.TdModeUtil.html">pyokx.okx_market_maker.utils.TdModeUtil</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.okx_market_maker.utils.WsOrderUtil.html">pyokx.okx_market_maker.utils.WsOrderUtil</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.redis_structured_reports.html">pyokx.redis_structured_reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.redis_structured_streams.html">pyokx.redis_structured_streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.rest_handling.html">pyokx.rest_handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.rest_messages_service.html">pyokx.rest_messages_service</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.strategy_handling.html">pyokx.strategy_handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.AccountTest.html">pyokx.test.AccountTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.BlockTradingTest.html">pyokx.test.BlockTradingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.BrokerTest.html">pyokx.test.BrokerTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.ConvertTest.html">pyokx.test.ConvertTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.CopyTradingTest.html">pyokx.test.CopyTradingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.EarningTest.html">pyokx.test.EarningTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.FundingTest.html">pyokx.test.FundingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.GridTest.html">pyokx.test.GridTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.MarketTest.html">pyokx.test.MarketTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.PublicDataTest.html">pyokx.test.PublicDataTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.SpreadTest.html">pyokx.test.SpreadTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.StackingTest.html">pyokx.test.StackingTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.SubAccountTest.html">pyokx.test.SubAccountTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.TradeTest.html">pyokx.test.TradeTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.TradingDataTest.html">pyokx.test.TradingDataTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.WsPrivateAsyncTest.html">pyokx.test.WsPrivateAsyncTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.test.WsPublicAsyncTest.html">pyokx.test.WsPublicAsyncTest</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.websocket_handling.html">pyokx.websocket_handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WebSocketFactory.html">pyokx.ws_clients.WebSocketFactory</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WsPprivateAsync.html">pyokx.ws_clients.WsPprivateAsync</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WsPublicAsync.html">pyokx.ws_clients.WsPublicAsync</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_clients.WsUtils.html">pyokx.ws_clients.WsUtils</a></li>
<li class="toctree-l1"><a class="reference internal" href="pyokx.ws_data_structures.html">pyokx.ws_data_structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="redis_tools.config.html">redis_tools.config</a></li>
<li class="toctree-l1"><a class="reference internal" href="redis_tools.consumers.html">redis_tools.consumers</a></li>
<li class="toctree-l1"><a class="reference internal" href="redis_tools.utils.html">redis_tools.utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest_app.html">rest_app</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.api_keys.html">routers.api_keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.login.html">routers.login</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.okx.html">routers.okx</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.okx_authentication.html">routers.okx_authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="routers.signup.html">routers.signup</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.command_execution.html">shared.command_execution</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.config.html">shared.config</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.configuration_parser.html">shared.configuration_parser</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.data_processing_utils.html">shared.data_processing_utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.file_directory_ops.html">shared.file_directory_ops</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.logging.html">shared.logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.string_dict_utils.html">shared.string_dict_utils</a></li>
<li class="toctree-l1"><a class="reference internal" href="shared.tmp_shared.html">shared.tmp_shared</a></li>
<li class="toctree-l1"><a class="reference internal" href="tradingview_tools.tradingview_widgets.html">tradingview_tools.tradingview_widgets</a></li>
<li class="toctree-l1"><a class="reference internal" href="websocket_app.html">websocket_app</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">AntBot</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">pyokx.data_structures</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/pyokx.data_structures.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="module-pyokx.data_structures">
<span id="pyokx-data-structures"></span><h1>pyokx.data_structures<a class="headerlink" href="#module-pyokx.data_structures" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">AccountBalanceData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adjEq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">borrowFroz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">details</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails" title="pyokx.data_structures.AccountBalanceDetails"><span class="pre">AccountBalanceDetails</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">imr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isoEq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mmr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notionalUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordFroz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">totalEq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#AccountBalanceData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. {‘adjEq’: ‘’, ‘borrowFroz’: ‘’, ‘details’: [{‘availBal’: ‘1’, ‘availEq’: ‘1’, ‘borrowFroz’: ‘’, ‘cashBal’: ‘1’, ‘ccy’: ‘BTC’, ‘crossLiab’: ‘’, ‘disEq’: ‘42219’, ‘eq’: ‘1’, ‘eqUsd’: ‘42219’, ‘fixedBal’: ‘0’, ‘frozenBal’: ‘0’, ‘interest’: ‘’, ‘isoEq’: ‘0’, ‘isoLiab’: ‘’, ‘isoUpl’: ‘0’, ‘liab’: ‘’, ‘maxLoan’: ‘’, ‘mgnRatio’: ‘’, ‘notionalLever’: ‘0’, ‘ordFrozen’: ‘0’, ‘spotInUseAmt’: ‘’, ‘spotIsoBal’: ‘0’, ‘stgyEq’: ‘0’, ‘twap’: ‘0’, ‘uTime’: ‘1703639691142’, ‘upl’: ‘0’, ‘uplLiab’: ‘’}, {‘availBal’: ‘100’, ‘availEq’: ‘100’, ‘borrowFroz’: ‘’, ‘cashBal’: ‘100’, ‘ccy’: ‘OKB’, ‘crossLiab’: ‘’, ‘disEq’: ‘5207.329999999999’, ‘eq’: ‘100’, ‘eqUsd’: ‘5481.4’, ‘fixedBal’: ‘0’, ‘frozenBal’: ‘0’, ‘interest’: ‘’, ‘isoEq’: ‘0’, ‘isoLiab’: ‘’, ‘isoUpl’: ‘0’, ‘liab’: ‘’, ‘maxLoan’: ‘’, ‘mgnRatio’: ‘’, ‘notionalLever’: ‘0’, ‘ordFrozen’: ‘0’, ‘spotInUseAmt’: ‘’, ‘spotIsoBal’: ‘0’, ‘stgyEq’: ‘0’, ‘twap’: ‘0’, ‘uTime’: ‘1703639691152’, ‘upl’: ‘0’, ‘uplLiab’: ‘’}, {‘availBal’: ‘5069.205129833334’, ‘availEq’: ‘5069.205129833334’, ‘borrowFroz’: ‘’, ‘cashBal’: ‘5069.205129833334’, ‘ccy’: ‘USDT’, ‘crossLiab’: ‘’, ‘disEq’: ‘5218.680085966916’, ‘eq’: ‘5217.0627965’, ‘eqUsd’: ‘5218.680085966916’, ‘fixedBal’: ‘0’, ‘frozenBal’: ‘147.85766666666666’, ‘interest’: ‘’, ‘isoEq’: ‘147.85766666666666’, ‘isoLiab’: ‘’, ‘isoUpl’: ‘2.5’, ‘liab’: ‘’, ‘maxLoan’: ‘’, ‘mgnRatio’: ‘’, ‘notionalLever’: ‘0’, ‘ordFrozen’: ‘0’, ‘spotInUseAmt’: ‘’, ‘spotIsoBal’: ‘0’, ‘stgyEq’: ‘0’, ‘twap’: ‘0’, ‘uTime’: ‘1703877105585’, ‘upl’: ‘2.5’, ‘uplLiab’: ‘’}, {‘availBal’: ‘1’, ‘availEq’: ‘1’, ‘borrowFroz’: ‘’, ‘cashBal’: ‘1’, ‘ccy’: ‘ETH’, ‘crossLiab’: ‘’, ‘disEq’: ‘2310.18’, ‘eq’: ‘1’, ‘eqUsd’: ‘2310.18’, ‘fixedBal’: ‘0’, ‘frozenBal’: ‘0’, ‘interest’: ‘’, ‘isoEq’: ‘0’, ‘isoLiab’: ‘’, ‘isoUpl’: ‘0’, ‘liab’: ‘’, ‘maxLoan’: ‘’, ‘mgnRatio’: ‘’, ‘notionalLever’: ‘0’, ‘ordFrozen’: ‘0’, ‘spotInUseAmt’: ‘’, ‘spotIsoBal’: ‘0’, ‘stgyEq’: ‘0’, ‘twap’: ‘0’, ‘uTime’: ‘1703639691162’, ‘upl’: ‘0’, ‘uplLiab’: ‘’}], ‘imr’: ‘’, ‘isoEq’: ‘147.90350254333333’, ‘mgnRatio’: ‘’, ‘mmr’: ‘’, ‘notionalUsd’: ‘’, ‘ordFroz’: ‘’, ‘totalEq’: ‘55229.26008596692’, ‘uTime’: ‘1703884466962’}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.adjEq">
<span class="sig-name descname"><span class="pre">adjEq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'adjEq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.adjEq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.borrowFroz">
<span class="sig-name descname"><span class="pre">borrowFroz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'borrowFroz'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.borrowFroz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.details">
<span class="sig-name descname"><span class="pre">details</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.AccountBalanceDetails" title="pyokx.data_structures.AccountBalanceDetails"><span class="pre">AccountBalanceDetails</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'details'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.details" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.imr">
<span class="sig-name descname"><span class="pre">imr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'imr'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.imr" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.isoEq">
<span class="sig-name descname"><span class="pre">isoEq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'isoEq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.isoEq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.mgnRatio">
<span class="sig-name descname"><span class="pre">mgnRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnRatio'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.mgnRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.mmr">
<span class="sig-name descname"><span class="pre">mmr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mmr'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.mmr" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'adjEq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'borrowFroz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'details':</span> <span class="pre">FieldInfo(annotation=List[AccountBalanceDetails],</span> <span class="pre">required=True),</span> <span class="pre">'imr':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'isoEq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnRatio':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mmr':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'notionalUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordFroz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'totalEq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.notionalUsd">
<span class="sig-name descname"><span class="pre">notionalUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'notionalUsd'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.notionalUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.ordFroz">
<span class="sig-name descname"><span class="pre">ordFroz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordFroz'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.ordFroz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.totalEq">
<span class="sig-name descname"><span class="pre">totalEq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'totalEq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.totalEq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceData.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceData.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">AccountBalanceDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">availBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">availEq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">borrowFroz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cashBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">crossLiab</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disEq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eqUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fixedBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frozenBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isoEq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isoLiab</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">isoUpl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liab</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxLoan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notionalLever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordFrozen</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotInUseAmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotIsoBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stgyEq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">twap</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uplLiab</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#AccountBalanceDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="simple">
<dt>e.g. {‘availBal’: ‘1’, ‘availEq’: ‘1’, ‘borrowFroz’: ‘’, ‘cashBal’: ‘1’, ‘ccy’: ‘BTC’, ‘crossLiab’: ‘’, ‘disEq’: ‘42219’,</dt><dd><p>‘eq’: ‘1’, ‘eqUsd’: ‘42219’, ‘fixedBal’: ‘0’, ‘frozenBal’: ‘0’, ‘interest’: ‘’, ‘isoEq’: ‘0’, ‘isoLiab’: ‘’,
‘isoUpl’: ‘0’, ‘liab’: ‘’, ‘maxLoan’: ‘’, ‘mgnRatio’: ‘’, ‘notionalLever’: ‘0’, ‘ordFrozen’: ‘0’, ‘spotInUseAmt’: ‘’,
‘spotIsoBal’: ‘0’, ‘stgyEq’: ‘0’, ‘twap’: ‘0’, ‘uTime’: ‘1703639691142’, ‘upl’: ‘0’, ‘uplLiab’: ‘’}</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.availBal">
<span class="sig-name descname"><span class="pre">availBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availBal'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.availBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.availEq">
<span class="sig-name descname"><span class="pre">availEq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availEq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.availEq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.borrowFroz">
<span class="sig-name descname"><span class="pre">borrowFroz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'borrowFroz'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.borrowFroz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.cashBal">
<span class="sig-name descname"><span class="pre">cashBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cashBal'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.cashBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.crossLiab">
<span class="sig-name descname"><span class="pre">crossLiab</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'crossLiab'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.crossLiab" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.disEq">
<span class="sig-name descname"><span class="pre">disEq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'disEq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.disEq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.eq">
<span class="sig-name descname"><span class="pre">eq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'eq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.eq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.eqUsd">
<span class="sig-name descname"><span class="pre">eqUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'eqUsd'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.eqUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.fixedBal">
<span class="sig-name descname"><span class="pre">fixedBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fixedBal'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.fixedBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.frozenBal">
<span class="sig-name descname"><span class="pre">frozenBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'frozenBal'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.frozenBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.interest">
<span class="sig-name descname"><span class="pre">interest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'interest'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.interest" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.isoEq">
<span class="sig-name descname"><span class="pre">isoEq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'isoEq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.isoEq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.isoLiab">
<span class="sig-name descname"><span class="pre">isoLiab</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'isoLiab'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.isoLiab" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.isoUpl">
<span class="sig-name descname"><span class="pre">isoUpl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'isoUpl'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.isoUpl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.liab">
<span class="sig-name descname"><span class="pre">liab</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liab'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.liab" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.maxLoan">
<span class="sig-name descname"><span class="pre">maxLoan</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxLoan'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.maxLoan" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.mgnRatio">
<span class="sig-name descname"><span class="pre">mgnRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnRatio'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.mgnRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'availBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'availEq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'borrowFroz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cashBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'crossLiab':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'disEq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'eq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'eqUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fixedBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'frozenBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'interest':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'isoEq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'isoLiab':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'isoUpl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liab':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxLoan':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnRatio':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'notionalLever':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordFrozen':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotInUseAmt':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotIsoBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'stgyEq':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'twap':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'upl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uplLiab':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.notionalLever">
<span class="sig-name descname"><span class="pre">notionalLever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'notionalLever'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.notionalLever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.ordFrozen">
<span class="sig-name descname"><span class="pre">ordFrozen</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordFrozen'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.ordFrozen" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.spotInUseAmt">
<span class="sig-name descname"><span class="pre">spotInUseAmt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotInUseAmt'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.spotInUseAmt" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.spotIsoBal">
<span class="sig-name descname"><span class="pre">spotIsoBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotIsoBal'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.spotIsoBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.stgyEq">
<span class="sig-name descname"><span class="pre">stgyEq</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stgyEq'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.stgyEq" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.twap">
<span class="sig-name descname"><span class="pre">twap</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'twap'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.twap" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.upl">
<span class="sig-name descname"><span class="pre">upl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'upl'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.upl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountBalanceDetails.uplLiab">
<span class="sig-name descname"><span class="pre">uplLiab</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uplLiab'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountBalanceDetails.uplLiab" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">AccountConfigData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">acctLv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autoLoan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctIsoMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">greeksType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kycLv</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">levelTmp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liquidationGear</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mainUid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnIsoMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">opAuth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">perm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">roleType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotOffsetType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotRoleType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotTraderInsts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traderInsts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#AccountConfigData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.AccountConfigData" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.acctLv">
<span class="sig-name descname"><span class="pre">acctLv</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'acctLv'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.acctLv" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.autoLoan">
<span class="sig-name descname"><span class="pre">autoLoan</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'autoLoan'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.autoLoan" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.ctIsoMode">
<span class="sig-name descname"><span class="pre">ctIsoMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ctIsoMode'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.ctIsoMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.greeksType">
<span class="sig-name descname"><span class="pre">greeksType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'greeksType'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.greeksType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.ip">
<span class="sig-name descname"><span class="pre">ip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ip'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.ip" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.kycLv">
<span class="sig-name descname"><span class="pre">kycLv</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'kycLv'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.kycLv" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.label">
<span class="sig-name descname"><span class="pre">label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'label'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.label" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.level">
<span class="sig-name descname"><span class="pre">level</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'level'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.level" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.levelTmp">
<span class="sig-name descname"><span class="pre">levelTmp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'levelTmp'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.levelTmp" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.liquidationGear">
<span class="sig-name descname"><span class="pre">liquidationGear</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liquidationGear'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.liquidationGear" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.mainUid">
<span class="sig-name descname"><span class="pre">mainUid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mainUid'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.mainUid" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.mgnIsoMode">
<span class="sig-name descname"><span class="pre">mgnIsoMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnIsoMode'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.mgnIsoMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'acctLv':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'autoLoan':</span> <span class="pre">FieldInfo(annotation=bool,</span> <span class="pre">required=True),</span> <span class="pre">'ctIsoMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'greeksType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ip':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'kycLv':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'label':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'level':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'levelTmp':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liquidationGear':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mainUid':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnIsoMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'opAuth':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'perm':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'roleType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotOffsetType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotRoleType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotTraderInsts':</span> <span class="pre">FieldInfo(annotation=List[str],</span> <span class="pre">required=True),</span> <span class="pre">'traderInsts':</span> <span class="pre">FieldInfo(annotation=List[str],</span> <span class="pre">required=True),</span> <span class="pre">'uid':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.opAuth">
<span class="sig-name descname"><span class="pre">opAuth</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'opAuth'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.opAuth" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.perm">
<span class="sig-name descname"><span class="pre">perm</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'perm'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.perm" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.posMode">
<span class="sig-name descname"><span class="pre">posMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posMode'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.posMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.roleType">
<span class="sig-name descname"><span class="pre">roleType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'roleType'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.roleType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.spotOffsetType">
<span class="sig-name descname"><span class="pre">spotOffsetType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotOffsetType'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.spotOffsetType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.spotRoleType">
<span class="sig-name descname"><span class="pre">spotRoleType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotRoleType'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.spotRoleType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.spotTraderInsts">
<span class="sig-name descname"><span class="pre">spotTraderInsts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotTraderInsts'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.spotTraderInsts" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.traderInsts">
<span class="sig-name descname"><span class="pre">traderInsts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'traderInsts'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.traderInsts" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountConfigData.uid">
<span class="sig-name descname"><span class="pre">uid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uid'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountConfigData.uid" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">AccountStatusReport</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'2024-02-20</span> <span class="pre">01:48:34'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">account_balance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData" title="pyokx.data_structures.AccountBalanceData"><span class="pre">AccountBalanceData</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">account_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.AccountConfigData" title="pyokx.data_structures.AccountConfigData"><span class="pre">AccountConfigData</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_positions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Position" title="pyokx.data_structures.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_orders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Order" title="pyokx.data_structures.Order"><span class="pre">Order</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">all_algo_orders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Algo_Order" title="pyokx.data_structures.Algo_Order"><span class="pre">Algo_Order</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">simplified_balance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details" title="pyokx.data_structures.Simplified_Balance_Details"><span class="pre">Simplified_Balance_Details</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#AccountStatusReport"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.account_balance">
<span class="sig-name descname"><span class="pre">account_balance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.AccountBalanceData" title="pyokx.data_structures.AccountBalanceData"><span class="pre">AccountBalanceData</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'account_balance'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.account_balance" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.account_config">
<span class="sig-name descname"><span class="pre">account_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.AccountConfigData" title="pyokx.data_structures.AccountConfigData"><span class="pre">AccountConfigData</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'account_config'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.account_config" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.all_algo_orders">
<span class="sig-name descname"><span class="pre">all_algo_orders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Algo_Order" title="pyokx.data_structures.Algo_Order"><span class="pre">Algo_Order</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all_algo_orders'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.all_algo_orders" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.all_orders">
<span class="sig-name descname"><span class="pre">all_orders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Order" title="pyokx.data_structures.Order"><span class="pre">Order</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all_orders'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.all_orders" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.all_positions">
<span class="sig-name descname"><span class="pre">all_positions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Position" title="pyokx.data_structures.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'all_positions'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.all_positions" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'account_balance':</span> <span class="pre">FieldInfo(annotation=AccountBalanceData,</span> <span class="pre">required=True),</span> <span class="pre">'account_config':</span> <span class="pre">FieldInfo(annotation=AccountConfigData,</span> <span class="pre">required=True),</span> <span class="pre">'all_algo_orders':</span> <span class="pre">FieldInfo(annotation=List[Algo_Order],</span> <span class="pre">required=True),</span> <span class="pre">'all_orders':</span> <span class="pre">FieldInfo(annotation=List[Order],</span> <span class="pre">required=True),</span> <span class="pre">'all_positions':</span> <span class="pre">FieldInfo(annotation=List[Position],</span> <span class="pre">required=True),</span> <span class="pre">'simplified_balance':</span> <span class="pre">FieldInfo(annotation=Simplified_Balance_Details,</span> <span class="pre">required=True),</span> <span class="pre">'timestamp':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='2024-02-20</span> <span class="pre">01:48:34')}</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.simplified_balance">
<span class="sig-name descname"><span class="pre">simplified_balance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.Simplified_Balance_Details" title="pyokx.data_structures.Simplified_Balance_Details"><span class="pre">Simplified_Balance_Details</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'simplified_balance'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.simplified_balance" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.AccountStatusReport.timestamp">
<span class="sig-name descname"><span class="pre">timestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timestamp'</span></em><a class="headerlink" href="#pyokx.data_structures.AccountStatusReport.timestamp" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Algo_Order</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">activePx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actualPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actualSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">actualSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoClOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">amendPxOnTriggerType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attachAlgoOrds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callbackRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callbackSpread</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">closeFraction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failCode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">moveTriggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordIdList</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxLimit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxSpread</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxVar</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quickMgnType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reduceOnly</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slOrdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slTriggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slTriggerPxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">szLimit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tdMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tgtCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeInterval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpOrdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpTriggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpTriggerPxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">triggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">triggerPxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">triggerTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Algo_Order"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Algo_Order" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. {‘activePx’: ‘’, ‘actualPx’: ‘’, ‘actualSide’: ‘’, ‘actualSz’: ‘0’, ‘algoClOrdId’: ‘’, ‘algoId’: ‘660707839958183936’, ‘amendPxOnTriggerType’: ‘0’, ‘attachAlgoOrds’: [], ‘cTime’: ‘1703797024404’, ‘callbackRatio’: ‘’, ‘callbackSpread’: ‘’, ‘ccy’: ‘’, ‘clOrdId’: ‘’, ‘closeFraction’: ‘’, ‘failCode’: ‘’, ‘instId’: ‘BTC-USDT-240329’, ‘instType’: ‘FUTURES’, ‘last’: ‘44080’, ‘lever’: ‘3’, ‘moveTriggerPx’: ‘’, ‘ordId’: ‘’, ‘ordIdList’: [], ‘ordPx’: ‘’, ‘ordType’: ‘conditional’, ‘posSide’: ‘net’, ‘pxLimit’: ‘’, ‘pxSpread’: ‘’, ‘pxVar’: ‘’, ‘quickMgnType’: ‘’, ‘reduceOnly’: ‘false’, ‘side’: ‘buy’, ‘slOrdPx’: ‘’, ‘slTriggerPx’: ‘’, ‘slTriggerPxType’: ‘’, ‘state’: ‘live’, ‘sz’: ‘1’, ‘szLimit’: ‘’, ‘tag’: ‘’, ‘tdMode’: ‘isolated’, ‘tgtCcy’: ‘’, ‘timeInterval’: ‘’, ‘tpOrdPx’: ‘-1’, ‘tpTriggerPx’: ‘44075’, ‘tpTriggerPxType’: ‘last’, ‘triggerPx’: ‘’, ‘triggerPxType’: ‘’, ‘triggerTime’: ‘’}, {‘activePx’: ‘’, ‘actualPx’: ‘’, ‘actualSide’: ‘’, ‘actualSz’: ‘0’, ‘algoClOrdId’: ‘’, ‘algoId’: ‘660707810421895170’, ‘amendPxOnTriggerType’: ‘0’, ‘attachAlgoOrds’: [], ‘cTime’: ‘1703797017362’, ‘callbackRatio’: ‘’, ‘callbackSpread’: ‘’, ‘ccy’: ‘’, ‘clOrdId’: ‘’, ‘closeFraction’: ‘’, ‘failCode’: ‘’, ‘instId’: ‘BTC-USDT-240329’, ‘instType’: ‘FUTURES’, ‘last’: ‘44079.5’, ‘lever’: ‘3’, ‘moveTriggerPx’: ‘’, ‘ordId’: ‘’, ‘ordIdList’: [], ‘ordPx’: ‘’, ‘ordType’: ‘conditional’, ‘posSide’: ‘net’, ‘pxLimit’: ‘’, ‘pxSpread’: ‘’, ‘pxVar’: ‘’, ‘quickMgnType’: ‘’, ‘reduceOnly’: ‘false’, ‘side’: ‘buy’, ‘slOrdPx’: ‘’, ‘slTriggerPx’: ‘’, ‘slTriggerPxType’: ‘’, ‘state’: ‘live’, ‘sz’: ‘1’, ‘szLimit’: ‘’, ‘tag’: ‘’, ‘tdMode’: ‘isolated’, ‘tgtCcy’: ‘’, ‘timeInterval’: ‘’, ‘tpOrdPx’: ‘-1’, ‘tpTriggerPx’: ‘44074.5’, ‘tpTriggerPxType’: ‘last’, ‘triggerPx’: ‘’, ‘triggerPxType’: ‘’, ‘triggerTime’: ‘’}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.activePx">
<span class="sig-name descname"><span class="pre">activePx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'activePx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.activePx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.actualPx">
<span class="sig-name descname"><span class="pre">actualPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'actualPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.actualPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.actualSide">
<span class="sig-name descname"><span class="pre">actualSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'actualSide'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.actualSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.actualSz">
<span class="sig-name descname"><span class="pre">actualSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'actualSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.actualSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.algoClOrdId">
<span class="sig-name descname"><span class="pre">algoClOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoClOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.algoClOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.algoId">
<span class="sig-name descname"><span class="pre">algoId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.algoId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.amendPxOnTriggerType">
<span class="sig-name descname"><span class="pre">amendPxOnTriggerType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'amendPxOnTriggerType'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.amendPxOnTriggerType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.attachAlgoOrds">
<span class="sig-name descname"><span class="pre">attachAlgoOrds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'attachAlgoOrds'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.attachAlgoOrds" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.cTime">
<span class="sig-name descname"><span class="pre">cTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.cTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.callbackRatio">
<span class="sig-name descname"><span class="pre">callbackRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'callbackRatio'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.callbackRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.callbackSpread">
<span class="sig-name descname"><span class="pre">callbackSpread</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'callbackSpread'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.callbackSpread" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.closeFraction">
<span class="sig-name descname"><span class="pre">closeFraction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'closeFraction'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.closeFraction" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.failCode">
<span class="sig-name descname"><span class="pre">failCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'failCode'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.failCode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.last">
<span class="sig-name descname"><span class="pre">last</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'last'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.last" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.lever">
<span class="sig-name descname"><span class="pre">lever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lever'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.lever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'activePx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'actualPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'actualSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'actualSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoClOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'amendPxOnTriggerType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'attachAlgoOrds':</span> <span class="pre">FieldInfo(annotation=List[str],</span> <span class="pre">required=True),</span> <span class="pre">'cTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'callbackRatio':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'callbackSpread':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'closeFraction':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'failCode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lever':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'moveTriggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordIdList':</span> <span class="pre">FieldInfo(annotation=List[str],</span> <span class="pre">required=True),</span> <span class="pre">'ordPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxLimit':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxSpread':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxVar':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quickMgnType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'reduceOnly':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'side':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slOrdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slTriggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slTriggerPxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'state':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'szLimit':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tdMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tgtCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'timeInterval':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpOrdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpTriggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpTriggerPxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'triggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'triggerPxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'triggerTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.moveTriggerPx">
<span class="sig-name descname"><span class="pre">moveTriggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'moveTriggerPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.moveTriggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.ordId">
<span class="sig-name descname"><span class="pre">ordId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.ordId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.ordIdList">
<span class="sig-name descname"><span class="pre">ordIdList</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordIdList'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.ordIdList" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.ordPx">
<span class="sig-name descname"><span class="pre">ordPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.ordPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.ordType">
<span class="sig-name descname"><span class="pre">ordType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordType'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.ordType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.pxLimit">
<span class="sig-name descname"><span class="pre">pxLimit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxLimit'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.pxLimit" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.pxSpread">
<span class="sig-name descname"><span class="pre">pxSpread</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxSpread'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.pxSpread" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.pxVar">
<span class="sig-name descname"><span class="pre">pxVar</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxVar'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.pxVar" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.quickMgnType">
<span class="sig-name descname"><span class="pre">quickMgnType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quickMgnType'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.quickMgnType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.reduceOnly">
<span class="sig-name descname"><span class="pre">reduceOnly</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reduceOnly'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.reduceOnly" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.side">
<span class="sig-name descname"><span class="pre">side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'side'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.slOrdPx">
<span class="sig-name descname"><span class="pre">slOrdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slOrdPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.slOrdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.slTriggerPx">
<span class="sig-name descname"><span class="pre">slTriggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slTriggerPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.slTriggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.slTriggerPxType">
<span class="sig-name descname"><span class="pre">slTriggerPxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slTriggerPxType'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.slTriggerPxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.state">
<span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'state'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.state" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.sz">
<span class="sig-name descname"><span class="pre">sz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sz'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.sz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.szLimit">
<span class="sig-name descname"><span class="pre">szLimit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'szLimit'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.szLimit" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.tdMode">
<span class="sig-name descname"><span class="pre">tdMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tdMode'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.tdMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.tgtCcy">
<span class="sig-name descname"><span class="pre">tgtCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tgtCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.tgtCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.timeInterval">
<span class="sig-name descname"><span class="pre">timeInterval</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timeInterval'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.timeInterval" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.tpOrdPx">
<span class="sig-name descname"><span class="pre">tpOrdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpOrdPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.tpOrdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.tpTriggerPx">
<span class="sig-name descname"><span class="pre">tpTriggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpTriggerPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.tpTriggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.tpTriggerPxType">
<span class="sig-name descname"><span class="pre">tpTriggerPxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpTriggerPxType'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.tpTriggerPxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.triggerPx">
<span class="sig-name descname"><span class="pre">triggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'triggerPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.triggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.triggerPxType">
<span class="sig-name descname"><span class="pre">triggerPxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'triggerPxType'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.triggerPxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order.triggerTime">
<span class="sig-name descname"><span class="pre">triggerTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'triggerTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order.triggerTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Algo_Order_Placement_Return</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoClOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sCode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sMsg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Algo_Order_Placement_Return"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. {‘algoClOrdId’: ‘’, ‘algoId’: ‘660710963351515145’, ‘clOrdId’: ‘’, ‘sCode’: ‘0’, ‘sMsg’: ‘’, ‘tag’: ‘’}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.algoClOrdId">
<span class="sig-name descname"><span class="pre">algoClOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoClOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.algoClOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.algoId">
<span class="sig-name descname"><span class="pre">algoId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.algoId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'algoClOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sCode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sMsg':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.sCode">
<span class="sig-name descname"><span class="pre">sCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sCode'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.sCode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.sMsg">
<span class="sig-name descname"><span class="pre">sMsg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sMsg'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.sMsg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Algo_Order_Placement_Return.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.data_structures.Algo_Order_Placement_Return.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Ask">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Ask</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">price</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quantity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deprecated_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number_of_orders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Ask"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Ask" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. ‘43752.4’, ‘156’, ‘0’, ‘1’</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ask.deprecated_value">
<span class="sig-name descname"><span class="pre">deprecated_value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'deprecated_value'</span></em><a class="headerlink" href="#pyokx.data_structures.Ask.deprecated_value" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ask.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Ask.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ask.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'deprecated_value':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'number_of_orders':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'price':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quantity':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Ask.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ask.number_of_orders">
<span class="sig-name descname"><span class="pre">number_of_orders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'number_of_orders'</span></em><a class="headerlink" href="#pyokx.data_structures.Ask.number_of_orders" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ask.price">
<span class="sig-name descname"><span class="pre">price</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'price'</span></em><a class="headerlink" href="#pyokx.data_structures.Ask.price" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ask.quantity">
<span class="sig-name descname"><span class="pre">quantity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quantity'</span></em><a class="headerlink" href="#pyokx.data_structures.Ask.quantity" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Bid">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Bid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">price</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quantity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deprecated_value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number_of_orders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Bid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Bid" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. ‘43752.4’, ‘156’, ‘0’, ‘1’</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Bid.deprecated_value">
<span class="sig-name descname"><span class="pre">deprecated_value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'deprecated_value'</span></em><a class="headerlink" href="#pyokx.data_structures.Bid.deprecated_value" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Bid.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Bid.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Bid.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'deprecated_value':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'number_of_orders':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'price':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quantity':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Bid.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Bid.number_of_orders">
<span class="sig-name descname"><span class="pre">number_of_orders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'number_of_orders'</span></em><a class="headerlink" href="#pyokx.data_structures.Bid.number_of_orders" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Bid.price">
<span class="sig-name descname"><span class="pre">price</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'price'</span></em><a class="headerlink" href="#pyokx.data_structures.Bid.price" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Bid.quantity">
<span class="sig-name descname"><span class="pre">quantity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quantity'</span></em><a class="headerlink" href="#pyokx.data_structures.Bid.quantity" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Cancelled_Algo_Order</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoClOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sCode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sMsg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Cancelled_Algo_Order"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. {‘algoClOrdId’: ‘’, ‘algoId’: ‘661126556584251392’, ‘clOrdId’: ‘’, ‘sCode’: ‘0’, ‘sMsg’: ‘’, ‘tag’: ‘’}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.algoClOrdId">
<span class="sig-name descname"><span class="pre">algoClOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoClOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.algoClOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.algoId">
<span class="sig-name descname"><span class="pre">algoId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoId'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.algoId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'algoClOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sCode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sMsg':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.sCode">
<span class="sig-name descname"><span class="pre">sCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sCode'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.sCode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.sMsg">
<span class="sig-name descname"><span class="pre">sMsg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sMsg'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.sMsg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Algo_Order.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Algo_Order.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Order">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Cancelled_Order</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sCode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sMsg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Cancelled_Order"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Cancelled_Order" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Order.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Order.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Order.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Order.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Order.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sCode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sMsg':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Order.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Order.ordId">
<span class="sig-name descname"><span class="pre">ordId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordId'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Order.ordId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Order.sCode">
<span class="sig-name descname"><span class="pre">sCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sCode'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Order.sCode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Cancelled_Order.sMsg">
<span class="sig-name descname"><span class="pre">sMsg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sMsg'</span></em><a class="headerlink" href="#pyokx.data_structures.Cancelled_Order.sMsg" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Closed_Position">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Closed_Position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Closed_Position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Closed_Position" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. {‘clOrdId’: ‘’, ‘instId’: ‘BTC-USDT-240329’, ‘posSide’: ‘net’, ‘tag’: ‘’}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Closed_Position.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Closed_Position.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Closed_Position.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.Closed_Position.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Closed_Position.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Closed_Position.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Closed_Position.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Closed_Position.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Closed_Position.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.data_structures.Closed_Position.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Closed_Position.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.data_structures.Closed_Position.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">DCAInputParameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usd_amount</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trigger_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">execution_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_trigger_price_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_trigger_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_execution_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_trigger_price_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_trigger_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_execution_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#DCAInputParameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.execution_price_offset">
<span class="sig-name descname"><span class="pre">execution_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'execution_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.execution_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'execution_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'order_side':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'order_type':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sl_execution_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'sl_trigger_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'sl_trigger_price_type':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'tp_execution_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'tp_trigger_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'tp_trigger_price_type':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'trigger_price_offset':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'usd_amount':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.order_side">
<span class="sig-name descname"><span class="pre">order_side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'order_side'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.order_side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.order_type">
<span class="sig-name descname"><span class="pre">order_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'order_type'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.order_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.sl_execution_price_offset">
<span class="sig-name descname"><span class="pre">sl_execution_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_execution_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.sl_execution_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.sl_trigger_price_offset">
<span class="sig-name descname"><span class="pre">sl_trigger_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_trigger_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.sl_trigger_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.sl_trigger_price_type">
<span class="sig-name descname"><span class="pre">sl_trigger_price_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_trigger_price_type'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.sl_trigger_price_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.tp_execution_price_offset">
<span class="sig-name descname"><span class="pre">tp_execution_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_execution_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.tp_execution_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.tp_trigger_price_offset">
<span class="sig-name descname"><span class="pre">tp_trigger_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_trigger_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.tp_trigger_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.tp_trigger_price_type">
<span class="sig-name descname"><span class="pre">tp_trigger_price_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_trigger_price_type'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.tp_trigger_price_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.trigger_price_offset">
<span class="sig-name descname"><span class="pre">trigger_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'trigger_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.trigger_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAInputParameters.usd_amount">
<span class="sig-name descname"><span class="pre">usd_amount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'usd_amount'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAInputParameters.usd_amount" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">DCAOrderParameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trigger_price</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">execution_price</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_trigger_price_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_trigger_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_execution_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_trigger_price_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_trigger_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_execution_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#DCAOrderParameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.execution_price">
<span class="sig-name descname"><span class="pre">execution_price</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'execution_price'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.execution_price" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'execution_price':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=True),</span> <span class="pre">'side':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'size':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'sl_execution_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'sl_trigger_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'sl_trigger_price_type':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'tp_execution_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'tp_trigger_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'tp_trigger_price_type':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'trigger_price':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'type':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.side">
<span class="sig-name descname"><span class="pre">side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'side'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.size">
<span class="sig-name descname"><span class="pre">size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'size'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.size" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.sl_execution_price_offset">
<span class="sig-name descname"><span class="pre">sl_execution_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_execution_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.sl_execution_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.sl_trigger_price_offset">
<span class="sig-name descname"><span class="pre">sl_trigger_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_trigger_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.sl_trigger_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.sl_trigger_price_type">
<span class="sig-name descname"><span class="pre">sl_trigger_price_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_trigger_price_type'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.sl_trigger_price_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.tp_execution_price_offset">
<span class="sig-name descname"><span class="pre">tp_execution_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_execution_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.tp_execution_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.tp_trigger_price_offset">
<span class="sig-name descname"><span class="pre">tp_trigger_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_trigger_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.tp_trigger_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.tp_trigger_price_type">
<span class="sig-name descname"><span class="pre">tp_trigger_price_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_trigger_price_type'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.tp_trigger_price_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.trigger_price">
<span class="sig-name descname"><span class="pre">trigger_price</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'trigger_price'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.trigger_price" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.DCAOrderParameters.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'type'</span></em><a class="headerlink" href="#pyokx.data_structures.DCAOrderParameters.type" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">FillEntry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPxVol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillFwdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPxUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">billId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillMarkVol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">execType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillIdxPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tradeId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillMarkPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feeCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#FillEntry"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.FillEntry" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.billId">
<span class="sig-name descname"><span class="pre">billId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'billId'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.billId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.execType">
<span class="sig-name descname"><span class="pre">execType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'execType'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.execType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fee">
<span class="sig-name descname"><span class="pre">fee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fee'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.feeCcy">
<span class="sig-name descname"><span class="pre">feeCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'feeCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.feeCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillFwdPx">
<span class="sig-name descname"><span class="pre">fillFwdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillFwdPx'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillFwdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillIdxPx">
<span class="sig-name descname"><span class="pre">fillIdxPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillIdxPx'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillIdxPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillMarkPx">
<span class="sig-name descname"><span class="pre">fillMarkPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillMarkPx'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillMarkPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillMarkVol">
<span class="sig-name descname"><span class="pre">fillMarkVol</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillMarkVol'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillMarkVol" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillPnl">
<span class="sig-name descname"><span class="pre">fillPnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPnl'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillPnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillPx">
<span class="sig-name descname"><span class="pre">fillPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPx'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillPxUsd">
<span class="sig-name descname"><span class="pre">fillPxUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPxUsd'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillPxUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillPxVol">
<span class="sig-name descname"><span class="pre">fillPxVol</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPxVol'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillPxVol" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillSz">
<span class="sig-name descname"><span class="pre">fillSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillSz'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.fillTime">
<span class="sig-name descname"><span class="pre">fillTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillTime'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.fillTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'billId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'execType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'feeCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillFwdPx':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'fillIdxPx':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'fillMarkPx':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'fillMarkVol':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'fillPnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillPxUsd':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'fillPxVol':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'fillSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'side':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'tradeId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ts':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.ordId">
<span class="sig-name descname"><span class="pre">ordId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordId'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.ordId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.side">
<span class="sig-name descname"><span class="pre">side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'side'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.tradeId">
<span class="sig-name descname"><span class="pre">tradeId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tradeId'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.tradeId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillEntry.ts">
<span class="sig-name descname"><span class="pre">ts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts'</span></em><a class="headerlink" href="#pyokx.data_structures.FillEntry.ts" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetrics">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">FillHistoricalMetrics</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ONE_DAY</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ONE_WEEK</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ONE_MONTH</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">THREE_MONTHS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#FillHistoricalMetrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetrics" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetrics.ONE_DAY">
<span class="sig-name descname"><span class="pre">ONE_DAY</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ONE_DAY'</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetrics.ONE_DAY" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetrics.ONE_MONTH">
<span class="sig-name descname"><span class="pre">ONE_MONTH</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ONE_MONTH'</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetrics.ONE_MONTH" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetrics.ONE_WEEK">
<span class="sig-name descname"><span class="pre">ONE_WEEK</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ONE_WEEK'</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetrics.ONE_WEEK" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetrics.THREE_MONTHS">
<span class="sig-name descname"><span class="pre">THREE_MONTHS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="pyokx.data_structures.FillHistoricalMetricsEntry"><span class="pre">FillHistoricalMetricsEntry</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'THREE_MONTHS'</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetrics.THREE_MONTHS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetrics.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetrics.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetrics.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'ONE_DAY':</span> <span class="pre">FieldInfo(annotation=FillHistoricalMetricsEntry,</span> <span class="pre">required=True),</span> <span class="pre">'ONE_MONTH':</span> <span class="pre">FieldInfo(annotation=FillHistoricalMetricsEntry,</span> <span class="pre">required=True),</span> <span class="pre">'ONE_WEEK':</span> <span class="pre">FieldInfo(annotation=FillHistoricalMetricsEntry,</span> <span class="pre">required=True),</span> <span class="pre">'THREE_MONTHS':</span> <span class="pre">FieldInfo(annotation=FillHistoricalMetricsEntry,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetrics.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetricsEntry">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">FillHistoricalMetricsEntry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avg_fill_pnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total_fill_pnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total_fill_fee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#FillHistoricalMetricsEntry"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetricsEntry" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetricsEntry.avg_fill_pnl">
<span class="sig-name descname"><span class="pre">avg_fill_pnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'avg_fill_pnl'</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetricsEntry.avg_fill_pnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetricsEntry.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetricsEntry.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetricsEntry.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'avg_fill_pnl':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'total_fill_fee':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'total_fill_pnl':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetricsEntry.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetricsEntry.total_fill_fee">
<span class="sig-name descname"><span class="pre">total_fill_fee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'total_fill_fee'</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetricsEntry.total_fill_fee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.FillHistoricalMetricsEntry.total_fill_pnl">
<span class="sig-name descname"><span class="pre">total_fill_pnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'total_fill_pnl'</span></em><a class="headerlink" href="#pyokx.data_structures.FillHistoricalMetricsEntry.total_fill_pnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.InstIdSignalRequestForm">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">InstIdSignalRequestForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">InstIdAPIKey</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">OKXSignalInput</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput" title="pyokx.data_structures.OKXSignalInput"><span class="pre">OKXSignalInput</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#InstIdSignalRequestForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.InstIdSignalRequestForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstIdSignalRequestForm.InstIdAPIKey">
<span class="sig-name descname"><span class="pre">InstIdAPIKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'InstIdAPIKey'</span></em><a class="headerlink" href="#pyokx.data_structures.InstIdSignalRequestForm.InstIdAPIKey" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstIdSignalRequestForm.OKXSignalInput">
<span class="sig-name descname"><span class="pre">OKXSignalInput</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput" title="pyokx.data_structures.OKXSignalInput"><span class="pre">OKXSignalInput</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OKXSignalInput'</span></em><a class="headerlink" href="#pyokx.data_structures.InstIdSignalRequestForm.OKXSignalInput" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstIdSignalRequestForm.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.InstIdSignalRequestForm.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstIdSignalRequestForm.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'InstIdAPIKey':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'OKXSignalInput':</span> <span class="pre">FieldInfo(annotation=OKXSignalInput,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.InstIdSignalRequestForm.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Instrument</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctMult</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctVal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctValCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instFamily</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">listTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lotSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxIcebergSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxLmtAmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxLmtSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxMktAmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxMktSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxStopSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxTriggerSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxTwapSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quoteCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settleCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stk</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tickSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uly</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Instrument"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Instrument" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="simple">
<dt>e.g. {‘alias’: ‘next_month’, ‘baseCcy’: ‘’, ‘category’: ‘1’, ‘ctMult’: ‘1’, ‘ctType’: ‘inverse’, ‘ctVal’: ‘100’,</dt><dd><p>‘ctValCcy’: ‘USD’, ‘expTime’: ‘1708675200000’, ‘instFamily’: ‘BTC-USD’, ‘instId’: ‘BTC-USD-240223’,
‘instType’: ‘FUTURES’, ‘lever’: ‘100’, ‘listTime’: ‘1702627800062’, ‘lotSz’: ‘1’,
‘maxIcebergSz’: ‘1000000.0000000000000000’, ‘maxLmtAmt’: ‘1000000’, ‘maxLmtSz’: ‘1000000’, ‘maxMktAmt’: ‘’,
‘maxMktSz’: ‘10000’, ‘maxStopSz’: ‘10000’, ‘maxTriggerSz’: ‘1000000.0000000000000000’,
‘maxTwapSz’: ‘1000000.0000000000000000’, ‘minSz’: ‘1’, ‘optType’: ‘’, ‘quoteCcy’: ‘’, ‘settleCcy’: ‘BTC’,
‘state’: ‘live’, ‘stk’: ‘’, ‘tickSz’: ‘0.01’, ‘uly’: ‘BTC-USD’}</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.alias">
<span class="sig-name descname"><span class="pre">alias</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'alias'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.alias" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.baseCcy">
<span class="sig-name descname"><span class="pre">baseCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'baseCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.baseCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.category">
<span class="sig-name descname"><span class="pre">category</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'category'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.category" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.ctMult">
<span class="sig-name descname"><span class="pre">ctMult</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ctMult'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.ctMult" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.ctType">
<span class="sig-name descname"><span class="pre">ctType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ctType'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.ctType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.ctVal">
<span class="sig-name descname"><span class="pre">ctVal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ctVal'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.ctVal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.ctValCcy">
<span class="sig-name descname"><span class="pre">ctValCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ctValCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.ctValCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.expTime">
<span class="sig-name descname"><span class="pre">expTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'expTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.expTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.instFamily">
<span class="sig-name descname"><span class="pre">instFamily</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instFamily'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.instFamily" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.lever">
<span class="sig-name descname"><span class="pre">lever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lever'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.lever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.listTime">
<span class="sig-name descname"><span class="pre">listTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'listTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.listTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.lotSz">
<span class="sig-name descname"><span class="pre">lotSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lotSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.lotSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxIcebergSz">
<span class="sig-name descname"><span class="pre">maxIcebergSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxIcebergSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxIcebergSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxLmtAmt">
<span class="sig-name descname"><span class="pre">maxLmtAmt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxLmtAmt'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxLmtAmt" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxLmtSz">
<span class="sig-name descname"><span class="pre">maxLmtSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxLmtSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxLmtSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxMktAmt">
<span class="sig-name descname"><span class="pre">maxMktAmt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxMktAmt'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxMktAmt" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxMktSz">
<span class="sig-name descname"><span class="pre">maxMktSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxMktSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxMktSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxStopSz">
<span class="sig-name descname"><span class="pre">maxStopSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxStopSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxStopSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxTriggerSz">
<span class="sig-name descname"><span class="pre">maxTriggerSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxTriggerSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxTriggerSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.maxTwapSz">
<span class="sig-name descname"><span class="pre">maxTwapSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxTwapSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.maxTwapSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.minSz">
<span class="sig-name descname"><span class="pre">minSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'minSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.minSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'alias':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'baseCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'category':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ctMult':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ctType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ctVal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ctValCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'expTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instFamily':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lever':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'listTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lotSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxIcebergSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxLmtAmt':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxLmtSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxMktAmt':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxMktSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxStopSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxTriggerSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxTwapSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'minSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'optType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quoteCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'settleCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'state':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'stk':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tickSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uly':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.optType">
<span class="sig-name descname"><span class="pre">optType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'optType'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.optType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.quoteCcy">
<span class="sig-name descname"><span class="pre">quoteCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quoteCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.quoteCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.settleCcy">
<span class="sig-name descname"><span class="pre">settleCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'settleCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.settleCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.state">
<span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'state'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.state" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.stk">
<span class="sig-name descname"><span class="pre">stk</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stk'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.stk" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.tickSz">
<span class="sig-name descname"><span class="pre">tickSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tickSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.tickSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Instrument.uly">
<span class="sig-name descname"><span class="pre">uly</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uly'</span></em><a class="headerlink" href="#pyokx.data_structures.Instrument.uly" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">InstrumentStatusReport</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'2024-02-20</span> <span class="pre">01:48:34'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_order_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData" title="pyokx.data_structures.MaxOrderSizeData"><span class="pre">MaxOrderSizeData</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_avail_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData" title="pyokx.data_structures.MaxAvailSizeData"><span class="pre">MaxAvailSizeData</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">positions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Position" title="pyokx.data_structures.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">orders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Order" title="pyokx.data_structures.Order"><span class="pre">Order</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algo_orders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Algo_Order" title="pyokx.data_structures.Algo_Order"><span class="pre">Algo_Order</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#InstrumentStatusReport"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.algo_orders">
<span class="sig-name descname"><span class="pre">algo_orders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Algo_Order" title="pyokx.data_structures.Algo_Order"><span class="pre">Algo_Order</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algo_orders'</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.algo_orders" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.max_avail_size">
<span class="sig-name descname"><span class="pre">max_avail_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.MaxAvailSizeData" title="pyokx.data_structures.MaxAvailSizeData"><span class="pre">MaxAvailSizeData</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'max_avail_size'</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.max_avail_size" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.max_order_size">
<span class="sig-name descname"><span class="pre">max_order_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.MaxOrderSizeData" title="pyokx.data_structures.MaxOrderSizeData"><span class="pre">MaxOrderSizeData</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'max_order_size'</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.max_order_size" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'algo_orders':</span> <span class="pre">FieldInfo(annotation=List[Algo_Order],</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'max_avail_size':</span> <span class="pre">FieldInfo(annotation=MaxAvailSizeData,</span> <span class="pre">required=True),</span> <span class="pre">'max_order_size':</span> <span class="pre">FieldInfo(annotation=MaxOrderSizeData,</span> <span class="pre">required=True),</span> <span class="pre">'orders':</span> <span class="pre">FieldInfo(annotation=List[Order],</span> <span class="pre">required=True),</span> <span class="pre">'positions':</span> <span class="pre">FieldInfo(annotation=List[Position],</span> <span class="pre">required=True),</span> <span class="pre">'timestamp':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='2024-02-20</span> <span class="pre">01:48:34')}</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.orders">
<span class="sig-name descname"><span class="pre">orders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Order" title="pyokx.data_structures.Order"><span class="pre">Order</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'orders'</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.orders" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.positions">
<span class="sig-name descname"><span class="pre">positions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Position" title="pyokx.data_structures.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'positions'</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.positions" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.InstrumentStatusReport.timestamp">
<span class="sig-name descname"><span class="pre">timestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'timestamp'</span></em><a class="headerlink" href="#pyokx.data_structures.InstrumentStatusReport.timestamp" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxAvailSizeData">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">MaxAvailSizeData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">availBuy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">availSell</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#MaxAvailSizeData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.MaxAvailSizeData" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxAvailSizeData.availBuy">
<span class="sig-name descname"><span class="pre">availBuy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availBuy'</span></em><a class="headerlink" href="#pyokx.data_structures.MaxAvailSizeData.availBuy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxAvailSizeData.availSell">
<span class="sig-name descname"><span class="pre">availSell</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availSell'</span></em><a class="headerlink" href="#pyokx.data_structures.MaxAvailSizeData.availSell" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxAvailSizeData.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.MaxAvailSizeData.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxAvailSizeData.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.MaxAvailSizeData.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxAvailSizeData.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'availBuy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'availSell':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.MaxAvailSizeData.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxOrderSizeData">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">MaxOrderSizeData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxBuy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxSell</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#MaxOrderSizeData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.MaxOrderSizeData" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxOrderSizeData.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.data_structures.MaxOrderSizeData.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxOrderSizeData.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.MaxOrderSizeData.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxOrderSizeData.maxBuy">
<span class="sig-name descname"><span class="pre">maxBuy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxBuy'</span></em><a class="headerlink" href="#pyokx.data_structures.MaxOrderSizeData.maxBuy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxOrderSizeData.maxSell">
<span class="sig-name descname"><span class="pre">maxSell</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'maxSell'</span></em><a class="headerlink" href="#pyokx.data_structures.MaxOrderSizeData.maxSell" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxOrderSizeData.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.MaxOrderSizeData.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.MaxOrderSizeData.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxBuy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'maxSell':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.MaxOrderSizeData.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXBaseModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">OKXBaseModel</span></span><a class="reference internal" href="_modules/pyokx/data_structures.html#OKXBaseModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.OKXBaseModel" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXBaseModel.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.OKXBaseModel.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXBaseModel.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.OKXBaseModel.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXBaseModelModelMeta">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">OKXBaseModelModelMeta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">namespace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">__pydantic_generic_metadata__</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PydanticGenericMetadata</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">__pydantic_reset_parent_namespace__</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_create_model_module</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#OKXBaseModelModelMeta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.OKXBaseModelModelMeta" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelMetaclass</span></code></p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">OKXPremiumIndicatorSignalRequestForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">InstIdAPIKey</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">OKXSignalInput</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput" title="pyokx.data_structures.OKXSignalInput"><span class="pre">OKXSignalInput</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">PremiumIndicatorSignals</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals" title="pyokx.data_structures.PremiumIndicatorSignals"><span class="pre">PremiumIndicatorSignals</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#OKXPremiumIndicatorSignalRequestForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.InstIdAPIKey">
<span class="sig-name descname"><span class="pre">InstIdAPIKey</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'InstIdAPIKey'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.InstIdAPIKey" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.OKXSignalInput">
<span class="sig-name descname"><span class="pre">OKXSignalInput</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.OKXSignalInput" title="pyokx.data_structures.OKXSignalInput"><span class="pre">OKXSignalInput</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OKXSignalInput'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.OKXSignalInput" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.PremiumIndicatorSignals">
<span class="sig-name descname"><span class="pre">PremiumIndicatorSignals</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyokx.data_structures.PremiumIndicatorSignals" title="pyokx.data_structures.PremiumIndicatorSignals"><span class="pre">PremiumIndicatorSignals</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PremiumIndicatorSignals'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.PremiumIndicatorSignals" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'InstIdAPIKey':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'OKXSignalInput':</span> <span class="pre">FieldInfo(annotation=OKXSignalInput,</span> <span class="pre">required=True),</span> <span class="pre">'PremiumIndicatorSignals':</span> <span class="pre">FieldInfo(annotation=PremiumIndicatorSignals,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.to_tradingview_json_payload">
<span class="sig-name descname"><span class="pre">to_tradingview_json_payload</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#OKXPremiumIndicatorSignalRequestForm.to_tradingview_json_payload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm.to_tradingview_json_payload" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">OKXSignalInput</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instID</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usd_order_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">leverage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_orderbook_limit_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flip_position_if_opposite_side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clear_prior_to_new_order</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">red_button</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_trigger_price_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_trigger_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tp_execution_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_trigger_price_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_trigger_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sl_execution_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trailing_stop_activation_price_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trailing_stop_callback_offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dca_parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters" title="pyokx.data_structures.DCAInputParameters"><span class="pre">DCAInputParameters</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#OKXSignalInput"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.clear_prior_to_new_order">
<span class="sig-name descname"><span class="pre">clear_prior_to_new_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clear_prior_to_new_order'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.clear_prior_to_new_order" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.dca_parameters">
<span class="sig-name descname"><span class="pre">dca_parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.DCAInputParameters" title="pyokx.data_structures.DCAInputParameters"><span class="pre">DCAInputParameters</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'dca_parameters'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.dca_parameters" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.flip_position_if_opposite_side">
<span class="sig-name descname"><span class="pre">flip_position_if_opposite_side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'flip_position_if_opposite_side'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.flip_position_if_opposite_side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.instID">
<span class="sig-name descname"><span class="pre">instID</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instID'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.instID" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.leverage">
<span class="sig-name descname"><span class="pre">leverage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'leverage'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.leverage" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.max_orderbook_limit_price_offset">
<span class="sig-name descname"><span class="pre">max_orderbook_limit_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'max_orderbook_limit_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.max_orderbook_limit_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'clear_prior_to_new_order':</span> <span class="pre">FieldInfo(annotation=Union[bool,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=False),</span> <span class="pre">'dca_parameters':</span> <span class="pre">FieldInfo(annotation=Union[List[DCAInputParameters],</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=[]),</span> <span class="pre">'flip_position_if_opposite_side':</span> <span class="pre">FieldInfo(annotation=Union[bool,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=False),</span> <span class="pre">'instID':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'leverage':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'max_orderbook_limit_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'order_side':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'order_type':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'red_button':</span> <span class="pre">FieldInfo(annotation=Union[bool,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=False),</span> <span class="pre">'sl_execution_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'sl_trigger_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'sl_trigger_price_type':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'tp_execution_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'tp_trigger_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'tp_trigger_price_type':</span> <span class="pre">FieldInfo(annotation=Union[str,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=''),</span> <span class="pre">'trailing_stop_activation_price_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'trailing_stop_callback_offset':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0),</span> <span class="pre">'usd_order_size':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False,</span> <span class="pre">default=0)}</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.order_side">
<span class="sig-name descname"><span class="pre">order_side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'order_side'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.order_side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.order_type">
<span class="sig-name descname"><span class="pre">order_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'order_type'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.order_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.red_button">
<span class="sig-name descname"><span class="pre">red_button</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'red_button'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.red_button" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.sl_execution_price_offset">
<span class="sig-name descname"><span class="pre">sl_execution_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_execution_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.sl_execution_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.sl_trigger_price_offset">
<span class="sig-name descname"><span class="pre">sl_trigger_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_trigger_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.sl_trigger_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.sl_trigger_price_type">
<span class="sig-name descname"><span class="pre">sl_trigger_price_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sl_trigger_price_type'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.sl_trigger_price_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.tp_execution_price_offset">
<span class="sig-name descname"><span class="pre">tp_execution_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_execution_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.tp_execution_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.tp_trigger_price_offset">
<span class="sig-name descname"><span class="pre">tp_trigger_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_trigger_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.tp_trigger_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.tp_trigger_price_type">
<span class="sig-name descname"><span class="pre">tp_trigger_price_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tp_trigger_price_type'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.tp_trigger_price_type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.trailing_stop_activation_price_offset">
<span class="sig-name descname"><span class="pre">trailing_stop_activation_price_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'trailing_stop_activation_price_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.trailing_stop_activation_price_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.trailing_stop_callback_offset">
<span class="sig-name descname"><span class="pre">trailing_stop_callback_offset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'trailing_stop_callback_offset'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.trailing_stop_callback_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.OKXSignalInput.usd_order_size">
<span class="sig-name descname"><span class="pre">usd_order_size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'usd_order_size'</span></em><a class="headerlink" href="#pyokx.data_structures.OKXSignalInput.usd_order_size" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Order">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Order</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">accFillSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoClOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algoId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attachAlgoClOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attachAlgoOrds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avgPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelSource</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancelSourceReason</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feeCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fillTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">px</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pxVol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quickMgnType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rebate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rebateCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reduceOnly</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">side</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slOrdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slTriggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slTriggerPxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stpId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stpMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tdMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tgtCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpOrdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpTriggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tpTriggerPxType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tradeId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Order"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Order" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.accFillSz">
<span class="sig-name descname"><span class="pre">accFillSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'accFillSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.accFillSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.algoClOrdId">
<span class="sig-name descname"><span class="pre">algoClOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoClOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.algoClOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.algoId">
<span class="sig-name descname"><span class="pre">algoId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'algoId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.algoId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.attachAlgoClOrdId">
<span class="sig-name descname"><span class="pre">attachAlgoClOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'attachAlgoClOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.attachAlgoClOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.attachAlgoOrds">
<span class="sig-name descname"><span class="pre">attachAlgoOrds</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'attachAlgoOrds'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.attachAlgoOrds" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.avgPx">
<span class="sig-name descname"><span class="pre">avgPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'avgPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.avgPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.cTime">
<span class="sig-name descname"><span class="pre">cTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.cTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.cancelSource">
<span class="sig-name descname"><span class="pre">cancelSource</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cancelSource'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.cancelSource" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.cancelSourceReason">
<span class="sig-name descname"><span class="pre">cancelSourceReason</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cancelSourceReason'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.cancelSourceReason" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.category">
<span class="sig-name descname"><span class="pre">category</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'category'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.category" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.fee">
<span class="sig-name descname"><span class="pre">fee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fee'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.fee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.feeCcy">
<span class="sig-name descname"><span class="pre">feeCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'feeCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.feeCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.fillPx">
<span class="sig-name descname"><span class="pre">fillPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.fillPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.fillSz">
<span class="sig-name descname"><span class="pre">fillSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.fillSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.fillTime">
<span class="sig-name descname"><span class="pre">fillTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fillTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.fillTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.lever">
<span class="sig-name descname"><span class="pre">lever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lever'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.lever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Order.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'accFillSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoClOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'algoId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'attachAlgoClOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'attachAlgoOrds':</span> <span class="pre">FieldInfo(annotation=List[str],</span> <span class="pre">required=True),</span> <span class="pre">'avgPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cancelSource':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cancelSourceReason':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'category':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'feeCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fillTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lever':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'px':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pxVol':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quickMgnType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'rebate':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'rebateCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'reduceOnly':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'side':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slOrdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slTriggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'slTriggerPxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'source':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'state':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'stpId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'stpMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tdMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tgtCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpOrdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpTriggerPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tpTriggerPxType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tradeId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Order.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.ordId">
<span class="sig-name descname"><span class="pre">ordId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.ordId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.ordType">
<span class="sig-name descname"><span class="pre">ordType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordType'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.ordType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.pnl">
<span class="sig-name descname"><span class="pre">pnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pnl'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.pnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.px">
<span class="sig-name descname"><span class="pre">px</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'px'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.px" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.pxType">
<span class="sig-name descname"><span class="pre">pxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxType'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.pxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.pxUsd">
<span class="sig-name descname"><span class="pre">pxUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxUsd'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.pxUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.pxVol">
<span class="sig-name descname"><span class="pre">pxVol</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pxVol'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.pxVol" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.quickMgnType">
<span class="sig-name descname"><span class="pre">quickMgnType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quickMgnType'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.quickMgnType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.rebate">
<span class="sig-name descname"><span class="pre">rebate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'rebate'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.rebate" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.rebateCcy">
<span class="sig-name descname"><span class="pre">rebateCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'rebateCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.rebateCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.reduceOnly">
<span class="sig-name descname"><span class="pre">reduceOnly</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'reduceOnly'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.reduceOnly" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.side">
<span class="sig-name descname"><span class="pre">side</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'side'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.side" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.slOrdPx">
<span class="sig-name descname"><span class="pre">slOrdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slOrdPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.slOrdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.slTriggerPx">
<span class="sig-name descname"><span class="pre">slTriggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slTriggerPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.slTriggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.slTriggerPxType">
<span class="sig-name descname"><span class="pre">slTriggerPxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'slTriggerPxType'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.slTriggerPxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.source">
<span class="sig-name descname"><span class="pre">source</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'source'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.source" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.state">
<span class="sig-name descname"><span class="pre">state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'state'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.state" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.stpId">
<span class="sig-name descname"><span class="pre">stpId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stpId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.stpId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.stpMode">
<span class="sig-name descname"><span class="pre">stpMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'stpMode'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.stpMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.sz">
<span class="sig-name descname"><span class="pre">sz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sz'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.sz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.tdMode">
<span class="sig-name descname"><span class="pre">tdMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tdMode'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.tdMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.tgtCcy">
<span class="sig-name descname"><span class="pre">tgtCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tgtCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.tgtCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.tpOrdPx">
<span class="sig-name descname"><span class="pre">tpOrdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpOrdPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.tpOrdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.tpTriggerPx">
<span class="sig-name descname"><span class="pre">tpTriggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpTriggerPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.tpTriggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.tpTriggerPxType">
<span class="sig-name descname"><span class="pre">tpTriggerPxType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tpTriggerPxType'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.tpTriggerPxType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.tradeId">
<span class="sig-name descname"><span class="pre">tradeId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tradeId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.tradeId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Order.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Order_Placement_Return</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clOrdId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sCode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sMsg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Order_Placement_Return"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. {‘clOrdId’: ‘’, ‘ordId’: ‘660478634888654848’, ‘sCode’: ‘0’, ‘sMsg’: ‘Order placed’, ‘tag’: ‘’}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return.clOrdId">
<span class="sig-name descname"><span class="pre">clOrdId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clOrdId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return.clOrdId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'clOrdId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ordId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sCode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sMsg':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tag':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return.ordId">
<span class="sig-name descname"><span class="pre">ordId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ordId'</span></em><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return.ordId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return.sCode">
<span class="sig-name descname"><span class="pre">sCode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sCode'</span></em><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return.sCode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return.sMsg">
<span class="sig-name descname"><span class="pre">sMsg</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sMsg'</span></em><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return.sMsg" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Order_Placement_Return.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tag'</span></em><a class="headerlink" href="#pyokx.data_structures.Order_Placement_Return.tag" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Orderbook_Snapshot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Ask" title="pyokx.data_structures.Ask"><span class="pre">Ask</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Bid" title="pyokx.data_structures.Bid"><span class="pre">Bid</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Orderbook_Snapshot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<blockquote>
<div><dl class="simple">
<dt>e.g. {‘asks’: [[‘43746.5’, ‘106’, ‘0’, ‘1’], [‘43751.1’, ‘171’, ‘0’, ‘1’], [‘43751.2’, ‘118’, ‘0’, ‘1’],</dt><dd><p>[‘43752.4’, ‘156’, ‘0’, ‘1’], [‘43753.5’, ‘151’, ‘0’, ‘1’], [‘43753.7’, ‘126’, ‘0’, ‘1’],
[‘43754.7’, ‘121’, ‘0’, ‘1’], [‘43754.8’, ‘158’, ‘0’, ‘1’], [‘43755.4’, ‘307’, ‘0’, ‘2’],
[‘43755.7’, ‘179’, ‘0’, ‘1’], [‘43756.4’, ‘134’, ‘0’, ‘1’], [‘43757’, ‘179’, ‘0’, ‘1’],
[‘43757.2’, ‘154’, ‘0’, ‘1’], [‘43757.3’, ‘171’, ‘0’, ‘1’], [‘43758.1’, ‘165’, ‘0’, ‘1’],
[‘43759.1’, ‘159’, ‘0’, ‘1’], [‘43759.2’, ‘128’, ‘0’, ‘1’], [‘43759.4’, ‘125’, ‘0’, ‘1’],
[‘43760.3’, ‘169’, ‘0’, ‘1’], [‘43922.5’, ‘1’, ‘0’, ‘1’]],</p>
</dd>
</dl>
</div></blockquote>
<dl class="simple">
<dt>‘bids’: [[‘43746.4’, ‘136’, ‘0’, ‘1’], [‘43746.3’, ‘151’, ‘0’, ‘1’], [‘43740.7’, ‘153’, ‘0’, ‘1’],</dt><dd><p>[‘43739.6’, ‘163’, ‘0’, ‘1’], [‘43739.3’, ‘143’, ‘0’, ‘1’], [‘43737.9’, ‘133’, ‘0’, ‘1’],
[‘43736.8’, ‘163’, ‘0’, ‘1’], [‘43735.1’, ‘168’, ‘0’, ‘1’], [‘43735’, ‘165’, ‘0’, ‘1’],
[‘43734.9’, ‘168’, ‘0’, ‘1’], [‘43733.8’, ‘171’, ‘0’, ‘1’], [‘43733.1’, ‘296’, ‘0’, ‘2’],
[‘43732.7’, ‘131’, ‘0’, ‘1’], [‘43732.6’, ‘127’, ‘0’, ‘1’], [‘43731.6’, ‘314’, ‘0’, ‘2’],
[‘43729’, ‘298’, ‘0’, ‘2’], [‘43728.8’, ‘180’, ‘0’, ‘1’], [‘43514’, ‘1’, ‘0’, ‘1’],
[‘43311.2’, ‘1’, ‘0’, ‘1’], [‘43109.3’, ‘1’, ‘0’, ‘1’]], ‘ts’: ‘1703914467407’}</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot.asks">
<span class="sig-name descname"><span class="pre">asks</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Ask" title="pyokx.data_structures.Ask"><span class="pre">Ask</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'asks'</span></em><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot.asks" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot.bids">
<span class="sig-name descname"><span class="pre">bids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyokx.data_structures.Bid" title="pyokx.data_structures.Bid"><span class="pre">Bid</span></a><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bids'</span></em><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot.bids" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot.depth">
<span class="sig-name descname"><span class="pre">depth</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'depth'</span></em><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot.depth" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'asks':</span> <span class="pre">FieldInfo(annotation=List[Ask],</span> <span class="pre">required=True),</span> <span class="pre">'bids':</span> <span class="pre">FieldInfo(annotation=List[Bid],</span> <span class="pre">required=True),</span> <span class="pre">'depth':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ts':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Orderbook_Snapshot.ts">
<span class="sig-name descname"><span class="pre">ts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts'</span></em><a class="headerlink" href="#pyokx.data_structures.Orderbook_Snapshot.ts" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Position">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">availPos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">avgPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseBorrowed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">baseInterest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bePx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bizRefId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bizRefType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">closeOrderAlgo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deltaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deltaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fundingFee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gammaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gammaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">idxPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">imr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liab</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liabCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liqPenalty</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liqPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">margin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">markPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mmr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notionalUsd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optVal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pendingCloseOrdLiabVal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posSide</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quoteBal</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quoteBorrowed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quoteInterest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">realizedPnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotInUseAmt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spotInUseCcy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thetaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thetaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tradeId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">upl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uplLastPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uplRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uplRatioLastPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">usdPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vegaBS</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vegaPA</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Position"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Position" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g. {‘adl’: ‘1’, ‘availPos’: ‘’, ‘avgPx’: ‘45075.3000000000000001’, ‘baseBal’: ‘’, ‘baseBorrowed’: ‘’, ‘baseInterest’: ‘’, ‘bePx’: ‘45120.39784892446’, ‘bizRefId’: ‘’, ‘bizRefType’: ‘’, ‘cTime’: ‘1703728631744’, ‘ccy’: ‘USDT’, ‘closeOrderAlgo’: [], ‘deltaBS’: ‘’, ‘deltaPA’: ‘’, ‘fee’: ‘-0.901506’, ‘fundingFee’: ‘0’, ‘gammaBS’: ‘’, ‘gammaPA’: ‘’, ‘idxPx’: ‘43474.0’, ‘imr’: ‘’, ‘instId’: ‘BTC-USDT-240329’, ‘instType’: ‘FUTURES’, ‘interest’: ‘’, ‘last’: ‘45070.1’, ‘lever’: ‘3’, ‘liab’: ‘’, ‘liabCcy’: ‘’, ‘liqPenalty’: ‘0’, ‘liqPx’: ‘30186.137167252637’, ‘margin’: ‘601.004’, ‘markPx’: ‘45068’, ‘mgnMode’: ‘isolated’, ‘mgnRatio’: ‘74.05007741388319’, ‘mmr’: ‘7.21088’, ‘notionalUsd’: ‘1804.4145568’, ‘optVal’: ‘’, ‘pendingCloseOrdLiabVal’: ‘’, ‘pnl’: ‘0’, ‘pos’: ‘4’, ‘posCcy’: ‘’, ‘posId’: ‘660420980350771429’, ‘posSide’: ‘net’, ‘quoteBal’: ‘’, ‘quoteBorrowed’: ‘’, ‘quoteInterest’: ‘’, ‘realizedPnl’: ‘-0.901506’, ‘spotInUseAmt’: ‘’, ‘spotInUseCcy’: ‘’, ‘thetaBS’: ‘’, ‘thetaPA’: ‘’, ‘tradeId’: ‘3014208’, ‘uTime’: ‘1703728655219’, ‘upl’: ‘-0.2920000000001164’, ‘uplLastPx’: ‘-0.2080000000001746’, ‘uplRatio’: ‘-0.0004858536715233’, ‘uplRatioLastPx’: ‘-0.0003460875468385’, ‘usdPx’: ‘’, ‘vegaBS’: ‘’, ‘vegaPA’: ‘’}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.adl">
<span class="sig-name descname"><span class="pre">adl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'adl'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.adl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.availPos">
<span class="sig-name descname"><span class="pre">availPos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'availPos'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.availPos" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.avgPx">
<span class="sig-name descname"><span class="pre">avgPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'avgPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.avgPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.baseBal">
<span class="sig-name descname"><span class="pre">baseBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'baseBal'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.baseBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.baseBorrowed">
<span class="sig-name descname"><span class="pre">baseBorrowed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'baseBorrowed'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.baseBorrowed" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.baseInterest">
<span class="sig-name descname"><span class="pre">baseInterest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'baseInterest'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.baseInterest" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.bePx">
<span class="sig-name descname"><span class="pre">bePx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bePx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.bePx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.bizRefId">
<span class="sig-name descname"><span class="pre">bizRefId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bizRefId'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.bizRefId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.bizRefType">
<span class="sig-name descname"><span class="pre">bizRefType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bizRefType'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.bizRefType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.cTime">
<span class="sig-name descname"><span class="pre">cTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.cTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.closeOrderAlgo">
<span class="sig-name descname"><span class="pre">closeOrderAlgo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'closeOrderAlgo'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.closeOrderAlgo" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.deltaBS">
<span class="sig-name descname"><span class="pre">deltaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'deltaBS'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.deltaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.deltaPA">
<span class="sig-name descname"><span class="pre">deltaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'deltaPA'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.deltaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.fee">
<span class="sig-name descname"><span class="pre">fee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fee'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.fee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.fundingFee">
<span class="sig-name descname"><span class="pre">fundingFee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fundingFee'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.fundingFee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.gammaBS">
<span class="sig-name descname"><span class="pre">gammaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'gammaBS'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.gammaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.gammaPA">
<span class="sig-name descname"><span class="pre">gammaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'gammaPA'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.gammaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.idxPx">
<span class="sig-name descname"><span class="pre">idxPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'idxPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.idxPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.imr">
<span class="sig-name descname"><span class="pre">imr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'imr'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.imr" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.interest">
<span class="sig-name descname"><span class="pre">interest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'interest'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.interest" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.last">
<span class="sig-name descname"><span class="pre">last</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'last'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.last" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.lever">
<span class="sig-name descname"><span class="pre">lever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lever'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.lever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.liab">
<span class="sig-name descname"><span class="pre">liab</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liab'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.liab" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.liabCcy">
<span class="sig-name descname"><span class="pre">liabCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liabCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.liabCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.liqPenalty">
<span class="sig-name descname"><span class="pre">liqPenalty</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liqPenalty'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.liqPenalty" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.liqPx">
<span class="sig-name descname"><span class="pre">liqPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liqPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.liqPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.margin">
<span class="sig-name descname"><span class="pre">margin</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'margin'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.margin" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.markPx">
<span class="sig-name descname"><span class="pre">markPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'markPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.markPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.mgnMode">
<span class="sig-name descname"><span class="pre">mgnMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnMode'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.mgnMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.mgnRatio">
<span class="sig-name descname"><span class="pre">mgnRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnRatio'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.mgnRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.mmr">
<span class="sig-name descname"><span class="pre">mmr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mmr'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.mmr" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Position.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'adl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'availPos':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'avgPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'baseBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'baseBorrowed':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'baseInterest':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bePx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bizRefId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bizRefType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'cTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'closeOrderAlgo':</span> <span class="pre">FieldInfo(annotation=List[dict],</span> <span class="pre">required=True),</span> <span class="pre">'deltaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'deltaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'fundingFee':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'gammaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'gammaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'idxPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'imr':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'interest':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lever':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liab':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liabCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liqPenalty':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'liqPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'margin':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'markPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnMode':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mgnRatio':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'mmr':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'notionalUsd':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'optVal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pendingCloseOrdLiabVal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'pos':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'posSide':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quoteBal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quoteBorrowed':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'quoteInterest':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'realizedPnl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotInUseAmt':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'spotInUseCcy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'thetaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'thetaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'tradeId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'upl':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uplLastPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uplRatio':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'uplRatioLastPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'usdPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'vegaBS':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'vegaPA':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Position.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.notionalUsd">
<span class="sig-name descname"><span class="pre">notionalUsd</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'notionalUsd'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.notionalUsd" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.optVal">
<span class="sig-name descname"><span class="pre">optVal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'optVal'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.optVal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.pendingCloseOrdLiabVal">
<span class="sig-name descname"><span class="pre">pendingCloseOrdLiabVal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pendingCloseOrdLiabVal'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.pendingCloseOrdLiabVal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.pnl">
<span class="sig-name descname"><span class="pre">pnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pnl'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.pnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.pos">
<span class="sig-name descname"><span class="pre">pos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pos'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.pos" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.posCcy">
<span class="sig-name descname"><span class="pre">posCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.posCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.posId">
<span class="sig-name descname"><span class="pre">posId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posId'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.posId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.posSide">
<span class="sig-name descname"><span class="pre">posSide</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posSide'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.posSide" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.quoteBal">
<span class="sig-name descname"><span class="pre">quoteBal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quoteBal'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.quoteBal" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.quoteBorrowed">
<span class="sig-name descname"><span class="pre">quoteBorrowed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quoteBorrowed'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.quoteBorrowed" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.quoteInterest">
<span class="sig-name descname"><span class="pre">quoteInterest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'quoteInterest'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.quoteInterest" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.realizedPnl">
<span class="sig-name descname"><span class="pre">realizedPnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'realizedPnl'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.realizedPnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.spotInUseAmt">
<span class="sig-name descname"><span class="pre">spotInUseAmt</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotInUseAmt'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.spotInUseAmt" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.spotInUseCcy">
<span class="sig-name descname"><span class="pre">spotInUseCcy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'spotInUseCcy'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.spotInUseCcy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.thetaBS">
<span class="sig-name descname"><span class="pre">thetaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'thetaBS'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.thetaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.thetaPA">
<span class="sig-name descname"><span class="pre">thetaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'thetaPA'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.thetaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.tradeId">
<span class="sig-name descname"><span class="pre">tradeId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'tradeId'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.tradeId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.upl">
<span class="sig-name descname"><span class="pre">upl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'upl'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.upl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.uplLastPx">
<span class="sig-name descname"><span class="pre">uplLastPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uplLastPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.uplLastPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.uplRatio">
<span class="sig-name descname"><span class="pre">uplRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uplRatio'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.uplRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.uplRatioLastPx">
<span class="sig-name descname"><span class="pre">uplRatioLastPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uplRatioLastPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.uplRatioLastPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.usdPx">
<span class="sig-name descname"><span class="pre">usdPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'usdPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.usdPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.vegaBS">
<span class="sig-name descname"><span class="pre">vegaBS</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'vegaBS'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.vegaBS" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Position.vegaPA">
<span class="sig-name descname"><span class="pre">vegaPA</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'vegaPA'</span></em><a class="headerlink" href="#pyokx.data_structures.Position.vegaPA" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">PositionHistory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html#pyokx.okx_market_maker.utils.OkxEnum.InstType" title="pyokx.okx_market_maker.utils.OkxEnum.InstType"><span class="pre">InstType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mgnMode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html#pyokx.okx_market_maker.utils.OkxEnum.MgnMode" title="pyokx.okx_market_maker.utils.OkxEnum.MgnMode"><span class="pre">MgnMode</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uTime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">openAvgPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">closeAvgPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">posId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">openMaxPos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">closeTotalPos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">realizedPnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fundingFee</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">liqPenalty</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pnl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pnlRatio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lever</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">direction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html#pyokx.okx_market_maker.utils.OkxEnum.PosSide" title="pyokx.okx_market_maker.utils.OkxEnum.PosSide"><span class="pre">PosSide</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">triggerPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uly</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ccy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#PositionHistory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.PositionHistory" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.Config">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Config</span></span><a class="reference internal" href="_modules/pyokx/data_structures.html#PositionHistory.Config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.PositionHistory.Config" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.Config.use_enum_values">
<span class="sig-name descname"><span class="pre">use_enum_values</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.Config.use_enum_values" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.cTime">
<span class="sig-name descname"><span class="pre">cTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'cTime'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.cTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.ccy">
<span class="sig-name descname"><span class="pre">ccy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ccy'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.ccy" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.closeAvgPx">
<span class="sig-name descname"><span class="pre">closeAvgPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'closeAvgPx'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.closeAvgPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.closeTotalPos">
<span class="sig-name descname"><span class="pre">closeTotalPos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'closeTotalPos'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.closeTotalPos" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.direction">
<span class="sig-name descname"><span class="pre">direction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html#pyokx.okx_market_maker.utils.OkxEnum.PosSide" title="pyokx.okx_market_maker.utils.OkxEnum.PosSide"><span class="pre">PosSide</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'direction'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.direction" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.fee">
<span class="sig-name descname"><span class="pre">fee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fee'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.fee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.fundingFee">
<span class="sig-name descname"><span class="pre">fundingFee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fundingFee'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.fundingFee" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.handle_triggerPx">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_triggerPx</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#PositionHistory.handle_triggerPx"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.PositionHistory.handle_triggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html#pyokx.okx_market_maker.utils.OkxEnum.InstType" title="pyokx.okx_market_maker.utils.OkxEnum.InstType"><span class="pre">InstType</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.lever">
<span class="sig-name descname"><span class="pre">lever</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lever'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.lever" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.liqPenalty">
<span class="sig-name descname"><span class="pre">liqPenalty</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'liqPenalty'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.liqPenalty" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.mgnMode">
<span class="sig-name descname"><span class="pre">mgnMode</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyokx.okx_market_maker.utils.OkxEnum.html#pyokx.okx_market_maker.utils.OkxEnum.MgnMode" title="pyokx.okx_market_maker.utils.OkxEnum.MgnMode"><span class="pre">MgnMode</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'mgnMode'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.mgnMode" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'use_enum_values':</span> <span class="pre">True}</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cTime':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=True),</span> <span class="pre">'ccy':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'closeAvgPx':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'closeTotalPos':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'direction':</span> <span class="pre">FieldInfo(annotation=PosSide,</span> <span class="pre">required=True),</span> <span class="pre">'fee':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'fundingFee':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=InstType,</span> <span class="pre">required=True),</span> <span class="pre">'lever':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'liqPenalty':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'mgnMode':</span> <span class="pre">FieldInfo(annotation=MgnMode,</span> <span class="pre">required=True),</span> <span class="pre">'openAvgPx':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'openMaxPos':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'pnl':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'pnlRatio':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'posId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'realizedPnl':</span> <span class="pre">FieldInfo(annotation=float,</span> <span class="pre">required=True),</span> <span class="pre">'triggerPx':</span> <span class="pre">FieldInfo(annotation=Union[float,</span> <span class="pre">NoneType],</span> <span class="pre">required=False),</span> <span class="pre">'type':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=True),</span> <span class="pre">'uTime':</span> <span class="pre">FieldInfo(annotation=int,</span> <span class="pre">required=True),</span> <span class="pre">'uly':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.openAvgPx">
<span class="sig-name descname"><span class="pre">openAvgPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'openAvgPx'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.openAvgPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.openMaxPos">
<span class="sig-name descname"><span class="pre">openMaxPos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'openMaxPos'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.openMaxPos" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.pnl">
<span class="sig-name descname"><span class="pre">pnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pnl'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.pnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.pnlRatio">
<span class="sig-name descname"><span class="pre">pnlRatio</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'pnlRatio'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.pnlRatio" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.posId">
<span class="sig-name descname"><span class="pre">posId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'posId'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.posId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.realizedPnl">
<span class="sig-name descname"><span class="pre">realizedPnl</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'realizedPnl'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.realizedPnl" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.triggerPx">
<span class="sig-name descname"><span class="pre">triggerPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'triggerPx'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.triggerPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'type'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.type" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.uTime">
<span class="sig-name descname"><span class="pre">uTime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uTime'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.uTime" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PositionHistory.uly">
<span class="sig-name descname"><span class="pre">uly</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'uly'</span></em><a class="headerlink" href="#pyokx.data_structures.PositionHistory.uly" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">PremiumIndicatorSignals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Bullish</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Bearish</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Bullish_plus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Bearish_plus</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Bullish_Exit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Bearish_Exit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#PremiumIndicatorSignals"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.Bearish">
<span class="sig-name descname"><span class="pre">Bearish</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Bearish'</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.Bearish" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.Bearish_Exit">
<span class="sig-name descname"><span class="pre">Bearish_Exit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Bearish_Exit'</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.Bearish_Exit" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.Bearish_plus">
<span class="sig-name descname"><span class="pre">Bearish_plus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Bearish_plus'</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.Bearish_plus" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.Bullish">
<span class="sig-name descname"><span class="pre">Bullish</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Bullish'</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.Bullish" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.Bullish_Exit">
<span class="sig-name descname"><span class="pre">Bullish_Exit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Bullish_Exit'</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.Bullish_Exit" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.Bullish_plus">
<span class="sig-name descname"><span class="pre">Bullish_plus</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Bullish_plus'</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.Bullish_plus" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'Bearish':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">str,</span> <span class="pre">NoneType],</span> <span class="pre">required=True),</span> <span class="pre">'Bearish_Exit':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">str,</span> <span class="pre">NoneType],</span> <span class="pre">required=True),</span> <span class="pre">'Bearish_plus':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">str,</span> <span class="pre">NoneType],</span> <span class="pre">required=True),</span> <span class="pre">'Bullish':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">str,</span> <span class="pre">NoneType],</span> <span class="pre">required=True),</span> <span class="pre">'Bullish_Exit':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">str,</span> <span class="pre">NoneType],</span> <span class="pre">required=True),</span> <span class="pre">'Bullish_plus':</span> <span class="pre">FieldInfo(annotation=Union[int,</span> <span class="pre">str,</span> <span class="pre">NoneType],</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="pyokx.data_structures.PremiumIndicatorSignals.tradingview_json_payload">
<span class="sig-name descname"><span class="pre">tradingview_json_payload</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#PremiumIndicatorSignals.tradingview_json_payload"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.PremiumIndicatorSignals.tradingview_json_payload" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Simplified_Balance_Details</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Currency</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Available_Balance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Equity</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Equity_in_USD</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Frozen_Balance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Simplified_Balance_Details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details.Available_Balance">
<span class="sig-name descname"><span class="pre">Available_Balance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Available_Balance'</span></em><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details.Available_Balance" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details.Currency">
<span class="sig-name descname"><span class="pre">Currency</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Currency'</span></em><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details.Currency" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details.Equity">
<span class="sig-name descname"><span class="pre">Equity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Equity'</span></em><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details.Equity" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details.Equity_in_USD">
<span class="sig-name descname"><span class="pre">Equity_in_USD</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Equity_in_USD'</span></em><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details.Equity_in_USD" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details.Frozen_Balance">
<span class="sig-name descname"><span class="pre">Frozen_Balance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Frozen_Balance'</span></em><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details.Frozen_Balance" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Simplified_Balance_Details.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'Available_Balance':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'Currency':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'Equity':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'Equity_in_USD':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'Frozen_Balance':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Simplified_Balance_Details.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyokx.data_structures.</span></span><span class="sig-name descname"><span class="pre">Ticker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instType</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lastSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">askPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">askSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bidPx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bidSz</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">open24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">high24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">low24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">volCcy24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">vol24h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sodUtc0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sodUtc8</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyokx/data_structures.html#Ticker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyokx.data_structures.Ticker" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyokx.data_structures.OKXBaseModel" title="pyokx.data_structures.OKXBaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">OKXBaseModel</span></code></a></p>
<p>e.g {‘instType’: ‘FUTURES’, ‘instId’: ‘BTC-USDT-240329’, ‘last’: ‘44725.3’, ‘lastSz’: ‘11’, ‘askPx’: ‘44727’, ‘askSz’: ‘147’, ‘bidPx’: ‘44724.5’, ‘bidSz’: ‘170’, ‘open24h’: ‘43854.9’, ‘high24h’: ‘45406.2’, ‘low24h’: ‘38196.8’, ‘volCcy24h’: ‘14025.4’, ‘vol24h’: ‘1402540’, ‘ts’: ‘1703741214308’, ‘sodUtc0’: ‘44977.8’, ‘sodUtc8’: ‘44452.3’}]}</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.askPx">
<span class="sig-name descname"><span class="pre">askPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'askPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.askPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.askSz">
<span class="sig-name descname"><span class="pre">askSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'askSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.askSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.bidPx">
<span class="sig-name descname"><span class="pre">bidPx</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bidPx'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.bidPx" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.bidSz">
<span class="sig-name descname"><span class="pre">bidSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bidSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.bidSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.high24h">
<span class="sig-name descname"><span class="pre">high24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'high24h'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.high24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.instId">
<span class="sig-name descname"><span class="pre">instId</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instId'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.instId" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.instType">
<span class="sig-name descname"><span class="pre">instType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'instType'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.instType" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.last">
<span class="sig-name descname"><span class="pre">last</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'last'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.last" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.lastSz">
<span class="sig-name descname"><span class="pre">lastSz</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'lastSz'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.lastSz" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.low24h">
<span class="sig-name descname"><span class="pre">low24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'low24h'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.low24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.model_config" title="Link to this definition"></a></dt>
<dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.model_fields">
<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">FieldInfo</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'askPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'askSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bidPx':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'bidSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'high24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instId':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'instType':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lastSz':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'low24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'open24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sodUtc0':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'sodUtc8':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'ts':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'vol24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'volCcy24h':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.model_fields" title="Link to this definition"></a></dt>
<dd><p>Metadata about the fields defined on the model,
mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</p>
<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.open24h">
<span class="sig-name descname"><span class="pre">open24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'open24h'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.open24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.sodUtc0">
<span class="sig-name descname"><span class="pre">sodUtc0</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sodUtc0'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.sodUtc0" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.sodUtc8">
<span class="sig-name descname"><span class="pre">sodUtc8</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'sodUtc8'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.sodUtc8" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.ts">
<span class="sig-name descname"><span class="pre">ts</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ts'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.ts" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.vol24h">
<span class="sig-name descname"><span class="pre">vol24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'vol24h'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.vol24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pyokx.data_structures.Ticker.volCcy24h">
<span class="sig-name descname"><span class="pre">volCcy24h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'volCcy24h'</span></em><a class="headerlink" href="#pyokx.data_structures.Ticker.volCcy24h" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

<div class="graphviz"><img src="_images/inheritance-809df5242e08342c6d89bd47ad9fae3fb855e340.png" alt="Inheritance diagram of pyokx.data_structures" usemap="#inheritancee527b6a4c1" class="inheritance graphviz" /></div>
<map id="inheritancee527b6a4c1" name="inheritancee527b6a4c1">
<area shape="rect" id="node2" href="#pyokx.data_structures.AccountBalanceData" target="_top" title="e.g. {&#39;adjEq&#39;: &#39;&#39;, &#39;borrowFroz&#39;: &#39;&#39;, &#39;details&#39;: [{&#39;availBal&#39;: &#39;1&#39;, &#39;availEq&#39;: &#39;1&#39;, &#39;borrowFroz&#39;: &#39;&#39;, &#39;cashBal&#39;: &#39;1&#39;, &#39;ccy&#39;: &#39;BTC&#39;, &#39;crossLiab&#39;: &#39;&#39;, &#39;disEq&#39;: &#39;42219&#39;, &#39;eq&#39;: &#39;1&#39;, &#39;eqUsd&#39;: &#39;42219&#39;, &#39;fixedBal&#39;: &#39;0&#39;, &#39;frozenBal&#39;: &#39;0&#39;, &#39;interest&#39;: &#39;&#39;, &#39;isoEq&#39;: &#39;0&#39;, &#39;isoLiab&#39;: &#39;&#39;, &#39;isoUpl&#39;: &#39;0&#39;, &#39;liab&#39;: &#39;&#39;, &#39;maxLoan&#39;: &#39;&#39;, &#39;mgnRatio&#39;: &#39;&#39;, &#39;notionalLever&#39;: &#39;0&#39;, &#39;ordFrozen&#39;: &#39;0&#39;, &#39;spotInUseAmt&#39;: &#39;&#39;, &#39;spotIsoBal&#39;: &#39;0&#39;, &#39;stgyEq&#39;: &#39;0&#39;, &#39;twap&#39;: &#39;0&#39;, &#39;uTime&#39;: &#39;1703639691142&#39;, &#39;upl&#39;: &#39;0&#39;, &#39;uplLiab&#39;: &#39;&#39;}, {&#39;availBal&#39;: &#39;100&#39;, &#39;availEq&#39;: &#39;100&#39;, &#39;borrowFroz&#39;: &#39;&#39;, &#39;cashBal&#39;: &#39;100&#39;, &#39;ccy&#39;: &#39;OKB&#39;, &#39;crossLiab&#39;: &#39;&#39;, &#39;disEq&#39;: &#39;5207.329999999999&#39;, &#39;eq&#39;: &#39;100&#39;, &#39;eqUsd&#39;: &#39;5481.4&#39;, &#39;fixedBal&#39;: &#39;0&#39;, &#39;frozenBal&#39;: &#39;0&#39;, &#39;interest&#39;: &#39;&#39;, &#39;isoEq&#39;: &#39;0&#39;, &#39;isoLiab&#39;: &#39;&#39;, &#39;isoUpl&#39;: &#39;0&#39;, &#39;liab&#39;: &#39;&#39;, &#39;maxLoan&#39;: &#39;&#39;, &#39;mgnRatio&#39;: &#39;&#39;, &#39;notionalLever&#39;: &#39;0&#39;, &#39;ordFrozen&#39;: &#39;0&#39;, &#39;spotInUseAmt&#39;: &#39;&#39;, &#39;spotIsoBal&#39;: &#39;0&#39;, &#39;stgyEq&#39;: &#39;0&#39;, &#39;twap&#39;: &#39;0&#39;, &#39;uTime&#39;: &#39;1703639691152&#39;, &#39;upl&#39;: &#39;0&#39;, &#39;uplLiab&#39;: &#39;&#39;}, {&#39;availBal&#39;: &#39;5069.205129833334&#39;, &#39;availEq&#39;: &#39;5069.205129833334&#39;, &#39;borrowFroz&#39;: &#39;&#39;, &#39;cashBal&#39;: &#39;5069.205129833334&#39;, &#39;ccy&#39;: &#39;USDT&#39;, &#39;crossLiab&#39;: &#39;&#39;, &#39;disEq&#39;: &#39;5218.680085966916&#39;, &#39;eq&#39;: &#39;5217.0627965&#39;, &#39;eqUsd&#39;: &#39;5218.680085966916&#39;, &#39;fixedBal&#39;: &#39;0&#39;, &#39;frozenBal&#39;: &#39;147.85766666666666&#39;, &#39;interest&#39;: &#39;&#39;, &#39;isoEq&#39;: &#39;147.85766666666666&#39;, &#39;isoLiab&#39;: &#39;&#39;, &#39;isoUpl&#39;: &#39;2.5&#39;, &#39;liab&#39;: &#39;&#39;, &#39;maxLoan&#39;: &#39;&#39;, &#39;mgnRatio&#39;: &#39;&#39;, &#39;notionalLever&#39;: &#39;0&#39;, &#39;ordFrozen&#39;: &#39;0&#39;, &#39;spotInUseAmt&#39;: &#39;&#39;, &#39;spotIsoBal&#39;: &#39;0&#39;, &#39;stgyEq&#39;: &#39;0&#39;, &#39;twap&#39;: &#39;0&#39;, &#39;uTime&#39;: &#39;1703877105585&#39;, &#39;upl&#39;: &#39;2.5&#39;, &#39;uplLiab&#39;: &#39;&#39;}, {&#39;availBal&#39;: &#39;1&#39;, &#39;availEq&#39;: &#39;1&#39;, &#39;borrowFroz&#39;: &#39;&#39;, &#39;cashBal&#39;: &#39;1&#39;, &#39;ccy&#39;: &#39;ETH&#39;, &#39;crossLiab&#39;: &#39;&#39;, &#39;disEq&#39;: &#39;2310.18&#39;, &#39;eq&#39;: &#39;1&#39;, &#39;eqUsd&#39;: &#39;2310.18&#39;, &#39;fixedBal&#39;: &#39;0&#39;, &#39;frozenBal&#39;: &#39;0&#39;, &#39;interest&#39;: &#39;&#39;, &#39;isoEq&#39;: &#39;0&#39;, &#39;isoLiab&#39;: &#39;&#39;, &#39;isoUpl&#39;: &#39;0&#39;, &#39;liab&#39;: &#39;&#39;, &#39;maxLoan&#39;: &#39;&#39;, &#39;mgnRatio&#39;: &#39;&#39;, &#39;notionalLever&#39;: &#39;0&#39;, &#39;ordFrozen&#39;: &#39;0&#39;, &#39;spotInUseAmt&#39;: &#39;&#39;, &#39;spotIsoBal&#39;: &#39;0&#39;, &#39;stgyEq&#39;: &#39;0&#39;, &#39;twap&#39;: &#39;0&#39;, &#39;uTime&#39;: &#39;1703639691162&#39;, &#39;upl&#39;: &#39;0&#39;, &#39;uplLiab&#39;: &#39;&#39;}], &#39;imr&#39;: &#39;&#39;, &#39;isoEq&#39;: &#39;147.90350254333333&#39;, &#39;mgnRatio&#39;: &#39;&#39;, &#39;mmr&#39;: &#39;&#39;, &#39;notionalUsd&#39;: &#39;&#39;, &#39;ordFroz&#39;: &#39;&#39;, &#39;totalEq&#39;: &#39;55229.26008596692&#39;, &#39;uTime&#39;: &#39;1703884466962&#39;}" alt="" coords="288,4,404,23"/>
<area shape="rect" id="node3" href="#pyokx.data_structures.OKXBaseModel" target="_top" title="OKXBaseModel" alt="" coords="111,549,201,567"/>
<area shape="rect" id="node4" href="#pyokx.data_structures.AccountBalanceDetails" target="_top" title="e.g. {&#39;availBal&#39;: &#39;1&#39;, &#39;availEq&#39;: &#39;1&#39;, &#39;borrowFroz&#39;: &#39;&#39;, &#39;cashBal&#39;: &#39;1&#39;, &#39;ccy&#39;: &#39;BTC&#39;, &#39;crossLiab&#39;: &#39;&#39;, &#39;disEq&#39;: &#39;42219&#39;," alt="" coords="283,40,409,59"/>
<area shape="rect" id="node5" href="#pyokx.data_structures.AccountConfigData" target="_top" title="AccountConfigData" alt="" coords="292,77,400,95"/>
<area shape="rect" id="node6" href="#pyokx.data_structures.AccountStatusReport" target="_top" title="AccountStatusReport" alt="" coords="288,113,404,131"/>
<area shape="rect" id="node7" href="#pyokx.data_structures.Algo_Order" target="_top" title="e.g. {&#39;activePx&#39;: &#39;&#39;, &#39;actualPx&#39;: &#39;&#39;, &#39;actualSide&#39;: &#39;&#39;, &#39;actualSz&#39;: &#39;0&#39;, &#39;algoClOrdId&#39;: &#39;&#39;, &#39;algoId&#39;: &#39;660707839958183936&#39;, &#39;amendPxOnTriggerType&#39;: &#39;0&#39;, &#39;attachAlgoOrds&#39;: [], &#39;cTime&#39;: &#39;1703797024404&#39;, &#39;callbackRatio&#39;: &#39;&#39;, &#39;callbackSpread&#39;: &#39;&#39;, &#39;ccy&#39;: &#39;&#39;, &#39;clOrdId&#39;: &#39;&#39;, &#39;closeFraction&#39;: &#39;&#39;, &#39;failCode&#39;: &#39;&#39;, &#39;instId&#39;: &#39;BTC&#45;USDT&#45;240329&#39;, &#39;instType&#39;: &#39;FUTURES&#39;, &#39;last&#39;: &#39;44080&#39;, &#39;lever&#39;: &#39;3&#39;, &#39;moveTriggerPx&#39;: &#39;&#39;, &#39;ordId&#39;: &#39;&#39;, &#39;ordIdList&#39;: [], &#39;ordPx&#39;: &#39;&#39;, &#39;ordType&#39;: &#39;conditional&#39;, &#39;posSide&#39;: &#39;net&#39;, &#39;pxLimit&#39;: &#39;&#39;, &#39;pxSpread&#39;: &#39;&#39;, &#39;pxVar&#39;: &#39;&#39;, &#39;quickMgnType&#39;: &#39;&#39;, &#39;reduceOnly&#39;: &#39;false&#39;, &#39;side&#39;: &#39;buy&#39;, &#39;slOrdPx&#39;: &#39;&#39;, &#39;slTriggerPx&#39;: &#39;&#39;, &#39;slTriggerPxType&#39;: &#39;&#39;, &#39;state&#39;: &#39;live&#39;, &#39;sz&#39;: &#39;1&#39;, &#39;szLimit&#39;: &#39;&#39;, &#39;tag&#39;: &#39;&#39;, &#39;tdMode&#39;: &#39;isolated&#39;, &#39;tgtCcy&#39;: &#39;&#39;, &#39;timeInterval&#39;: &#39;&#39;, &#39;tpOrdPx&#39;: &#39;&#45;1&#39;, &#39;tpTriggerPx&#39;: &#39;44075&#39;, &#39;tpTriggerPxType&#39;: &#39;last&#39;, &#39;triggerPx&#39;: &#39;&#39;, &#39;triggerPxType&#39;: &#39;&#39;, &#39;triggerTime&#39;: &#39;&#39;}, {&#39;activePx&#39;: &#39;&#39;, &#39;actualPx&#39;: &#39;&#39;, &#39;actualSide&#39;: &#39;&#39;, &#39;actualSz&#39;: &#39;0&#39;, &#39;algoClOrdId&#39;: &#39;&#39;, &#39;algoId&#39;: &#39;660707810421895170&#39;, &#39;amendPxOnTriggerType&#39;: &#39;0&#39;, &#39;attachAlgoOrds&#39;: [], &#39;cTime&#39;: &#39;1703797017362&#39;, &#39;callbackRatio&#39;: &#39;&#39;, &#39;callbackSpread&#39;: &#39;&#39;, &#39;ccy&#39;: &#39;&#39;, &#39;clOrdId&#39;: &#39;&#39;, &#39;closeFraction&#39;: &#39;&#39;, &#39;failCode&#39;: &#39;&#39;, &#39;instId&#39;: &#39;BTC&#45;USDT&#45;240329&#39;, &#39;instType&#39;: &#39;FUTURES&#39;, &#39;last&#39;: &#39;44079.5&#39;, &#39;lever&#39;: &#39;3&#39;, &#39;moveTriggerPx&#39;: &#39;&#39;, &#39;ordId&#39;: &#39;&#39;, &#39;ordIdList&#39;: [], &#39;ordPx&#39;: &#39;&#39;, &#39;ordType&#39;: &#39;conditional&#39;, &#39;posSide&#39;: &#39;net&#39;, &#39;pxLimit&#39;: &#39;&#39;, &#39;pxSpread&#39;: &#39;&#39;, &#39;pxVar&#39;: &#39;&#39;, &#39;quickMgnType&#39;: &#39;&#39;, &#39;reduceOnly&#39;: &#39;false&#39;, &#39;side&#39;: &#39;buy&#39;, &#39;slOrdPx&#39;: &#39;&#39;, &#39;slTriggerPx&#39;: &#39;&#39;, &#39;slTriggerPxType&#39;: &#39;&#39;, &#39;state&#39;: &#39;live&#39;, &#39;sz&#39;: &#39;1&#39;, &#39;szLimit&#39;: &#39;&#39;, &#39;tag&#39;: &#39;&#39;, &#39;tdMode&#39;: &#39;isolated&#39;, &#39;tgtCcy&#39;: &#39;&#39;, &#39;timeInterval&#39;: &#39;&#39;, &#39;tpOrdPx&#39;: &#39;&#45;1&#39;, &#39;tpTriggerPx&#39;: &#39;44074.5&#39;, &#39;tpTriggerPxType&#39;: &#39;last&#39;, &#39;triggerPx&#39;: &#39;&#39;, &#39;triggerPxType&#39;: &#39;&#39;, &#39;triggerTime&#39;: &#39;&#39;}" alt="" coords="311,149,381,168"/>
<area shape="rect" id="node8" href="#pyokx.data_structures.Algo_Order_Placement_Return" target="_top" title="e.g. {&#39;algoClOrdId&#39;: &#39;&#39;, &#39;algoId&#39;: &#39;660710963351515145&#39;, &#39;clOrdId&#39;: &#39;&#39;, &#39;sCode&#39;: &#39;0&#39;, &#39;sMsg&#39;: &#39;&#39;, &#39;tag&#39;: &#39;&#39;}" alt="" coords="265,185,427,204"/>
<area shape="rect" id="node9" href="#pyokx.data_structures.Ask" target="_top" title="e.g. &#39;43752.4&#39;, &#39;156&#39;, &#39;0&#39;, &#39;1&#39;" alt="" coords="319,222,372,240"/>
<area shape="rect" id="node11" href="#pyokx.data_structures.Bid" target="_top" title="e.g. &#39;43752.4&#39;, &#39;156&#39;, &#39;0&#39;, &#39;1&#39;" alt="" coords="319,258,372,277"/>
<area shape="rect" id="node12" href="#pyokx.data_structures.Cancelled_Algo_Order" target="_top" title="e.g. {&#39;algoClOrdId&#39;: &#39;&#39;, &#39;algoId&#39;: &#39;661126556584251392&#39;, &#39;clOrdId&#39;: &#39;&#39;, &#39;sCode&#39;: &#39;0&#39;, &#39;sMsg&#39;: &#39;&#39;, &#39;tag&#39;: &#39;&#39;}" alt="" coords="285,294,407,313"/>
<area shape="rect" id="node13" href="#pyokx.data_structures.Cancelled_Order" target="_top" title="Cancelled_Order" alt="" coords="298,331,393,349"/>
<area shape="rect" id="node14" href="#pyokx.data_structures.Closed_Position" target="_top" title="e.g. {&#39;clOrdId&#39;: &#39;&#39;, &#39;instId&#39;: &#39;BTC&#45;USDT&#45;240329&#39;, &#39;posSide&#39;: &#39;net&#39;, &#39;tag&#39;: &#39;&#39;}" alt="" coords="300,367,392,386"/>
<area shape="rect" id="node15" href="#pyokx.data_structures.DCAInputParameters" target="_top" title="DCAInputParameters" alt="" coords="288,403,404,422"/>
<area shape="rect" id="node16" href="#pyokx.data_structures.DCAOrderParameters" target="_top" title="DCAOrderParameters" alt="" coords="287,440,405,458"/>
<area shape="rect" id="node17" href="#pyokx.data_structures.FillEntry" target="_top" title="FillEntry" alt="" coords="318,476,373,495"/>
<area shape="rect" id="node18" href="#pyokx.data_structures.FillHistoricalMetrics" target="_top" title="FillHistoricalMetrics" alt="" coords="290,512,401,531"/>
<area shape="rect" id="node19" href="#pyokx.data_structures.FillHistoricalMetricsEntry" target="_top" title="FillHistoricalMetricsEntry" alt="" coords="278,549,414,567"/>
<area shape="rect" id="node20" href="#pyokx.data_structures.InstIdSignalRequestForm" target="_top" title="InstIdSignalRequestForm" alt="" coords="278,585,414,603"/>
<area shape="rect" id="node21" href="#pyokx.data_structures.Instrument" target="_top" title="e.g. {&#39;alias&#39;: &#39;next_month&#39;, &#39;baseCcy&#39;: &#39;&#39;, &#39;category&#39;: &#39;1&#39;, &#39;ctMult&#39;: &#39;1&#39;, &#39;ctType&#39;: &#39;inverse&#39;, &#39;ctVal&#39;: &#39;100&#39;," alt="" coords="312,621,380,640"/>
<area shape="rect" id="node22" href="#pyokx.data_structures.InstrumentStatusReport" target="_top" title="InstrumentStatusReport" alt="" coords="281,657,411,676"/>
<area shape="rect" id="node23" href="#pyokx.data_structures.MaxAvailSizeData" target="_top" title="MaxAvailSizeData" alt="" coords="294,694,397,712"/>
<area shape="rect" id="node24" href="#pyokx.data_structures.MaxOrderSizeData" target="_top" title="MaxOrderSizeData" alt="" coords="293,730,399,749"/>
<area shape="rect" id="node27" href="#pyokx.data_structures.OKXPremiumIndicatorSignalRequestForm" target="_top" title="OKXPremiumIndicatorSignalRequestForm" alt="" coords="238,766,453,785"/>
<area shape="rect" id="node28" href="#pyokx.data_structures.OKXSignalInput" target="_top" title="OKXSignalInput" alt="" coords="301,803,391,821"/>
<area shape="rect" id="node29" href="#pyokx.data_structures.Order" target="_top" title="Order" alt="" coords="319,839,372,858"/>
<area shape="rect" id="node30" href="#pyokx.data_structures.Order_Placement_Return" target="_top" title="e.g. {&#39;clOrdId&#39;: &#39;&#39;, &#39;ordId&#39;: &#39;660478634888654848&#39;, &#39;sCode&#39;: &#39;0&#39;, &#39;sMsg&#39;: &#39;Order placed&#39;, &#39;tag&#39;: &#39;&#39;}" alt="" coords="278,875,414,894"/>
<area shape="rect" id="node31" href="#pyokx.data_structures.Orderbook_Snapshot" target="_top" title="e.g. {&#39;asks&#39;: [[&#39;43746.5&#39;, &#39;106&#39;, &#39;0&#39;, &#39;1&#39;], [&#39;43751.1&#39;, &#39;171&#39;, &#39;0&#39;, &#39;1&#39;], [&#39;43751.2&#39;, &#39;118&#39;, &#39;0&#39;, &#39;1&#39;]," alt="" coords="288,912,404,930"/>
<area shape="rect" id="node32" href="#pyokx.data_structures.Position" target="_top" title="e.g. {&#39;adl&#39;: &#39;1&#39;, &#39;availPos&#39;: &#39;&#39;, &#39;avgPx&#39;: &#39;45075.3000000000000001&#39;, &#39;baseBal&#39;: &#39;&#39;, &#39;baseBorrowed&#39;: &#39;&#39;, &#39;baseInterest&#39;: &#39;&#39;, &#39;bePx&#39;: &#39;45120.39784892446&#39;, &#39;bizRefId&#39;: &#39;&#39;, &#39;bizRefType&#39;: &#39;&#39;, &#39;cTime&#39;: &#39;1703728631744&#39;, &#39;ccy&#39;: &#39;USDT&#39;, &#39;closeOrderAlgo&#39;: [], &#39;deltaBS&#39;: &#39;&#39;, &#39;deltaPA&#39;: &#39;&#39;, &#39;fee&#39;: &#39;&#45;0.901506&#39;, &#39;fundingFee&#39;: &#39;0&#39;, &#39;gammaBS&#39;: &#39;&#39;, &#39;gammaPA&#39;: &#39;&#39;, &#39;idxPx&#39;: &#39;43474.0&#39;, &#39;imr&#39;: &#39;&#39;, &#39;instId&#39;: &#39;BTC&#45;USDT&#45;240329&#39;, &#39;instType&#39;: &#39;FUTURES&#39;, &#39;interest&#39;: &#39;&#39;, &#39;last&#39;: &#39;45070.1&#39;, &#39;lever&#39;: &#39;3&#39;, &#39;liab&#39;: &#39;&#39;, &#39;liabCcy&#39;: &#39;&#39;, &#39;liqPenalty&#39;: &#39;0&#39;, &#39;liqPx&#39;: &#39;30186.137167252637&#39;, &#39;margin&#39;: &#39;601.004&#39;, &#39;markPx&#39;: &#39;45068&#39;, &#39;mgnMode&#39;: &#39;isolated&#39;, &#39;mgnRatio&#39;: &#39;74.05007741388319&#39;, &#39;mmr&#39;: &#39;7.21088&#39;, &#39;notionalUsd&#39;: &#39;1804.4145568&#39;, &#39;optVal&#39;: &#39;&#39;, &#39;pendingCloseOrdLiabVal&#39;: &#39;&#39;, &#39;pnl&#39;: &#39;0&#39;, &#39;pos&#39;: &#39;4&#39;, &#39;posCcy&#39;: &#39;&#39;, &#39;posId&#39;: &#39;660420980350771429&#39;, &#39;posSide&#39;: &#39;net&#39;, &#39;quoteBal&#39;: &#39;&#39;, &#39;quoteBorrowed&#39;: &#39;&#39;, &#39;quoteInterest&#39;: &#39;&#39;, &#39;realizedPnl&#39;: &#39;&#45;0.901506&#39;, &#39;spotInUseAmt&#39;: &#39;&#39;, &#39;spotInUseCcy&#39;: &#39;&#39;, &#39;thetaBS&#39;: &#39;&#39;, &#39;thetaPA&#39;: &#39;&#39;, &#39;tradeId&#39;: &#39;3014208&#39;, &#39;uTime&#39;: &#39;1703728655219&#39;, &#39;upl&#39;: &#39;&#45;0.2920000000001164&#39;, &#39;uplLastPx&#39;: &#39;&#45;0.2080000000001746&#39;, &#39;uplRatio&#39;: &#39;&#45;0.0004858536715233&#39;, &#39;uplRatioLastPx&#39;: &#39;&#45;0.0003460875468385&#39;, &#39;usdPx&#39;: &#39;&#39;, &#39;vegaBS&#39;: &#39;&#39;, &#39;vegaPA&#39;: &#39;&#39;}" alt="" coords="318,948,373,967"/>
<area shape="rect" id="node33" href="#pyokx.data_structures.PositionHistory" target="_top" title="PositionHistory" alt="" coords="301,984,391,1003"/>
<area shape="rect" id="node34" href="#pyokx.data_structures.PremiumIndicatorSignals" target="_top" title="PremiumIndicatorSignals" alt="" coords="278,1021,414,1039"/>
<area shape="rect" id="node35" href="#pyokx.data_structures.Simplified_Balance_Details" target="_top" title="Simplified_Balance_Details" alt="" coords="273,1057,419,1075"/>
<area shape="rect" id="node36" href="#pyokx.data_structures.Ticker" target="_top" title="e.g {&#39;instType&#39;: &#39;FUTURES&#39;, &#39;instId&#39;: &#39;BTC&#45;USDT&#45;240329&#39;, &#39;last&#39;: &#39;44725.3&#39;, &#39;lastSz&#39;: &#39;11&#39;, &#39;askPx&#39;: &#39;44727&#39;, &#39;askSz&#39;: &#39;147&#39;, &#39;bidPx&#39;: &#39;44724.5&#39;, &#39;bidSz&#39;: &#39;170&#39;, &#39;open24h&#39;: &#39;43854.9&#39;, &#39;high24h&#39;: &#39;45406.2&#39;, &#39;low24h&#39;: &#39;38196.8&#39;, &#39;volCcy24h&#39;: &#39;14025.4&#39;, &#39;vol24h&#39;: &#39;1402540&#39;, &#39;ts&#39;: &#39;1703741214308&#39;, &#39;sodUtc0&#39;: &#39;44977.8&#39;, &#39;sodUtc8&#39;: &#39;44452.3&#39;}]}" alt="" coords="319,1093,372,1112"/>
<area shape="rect" id="node26" href="#pyokx.data_structures.OKXBaseModelModelMeta" target="_top" title="OKXBaseModelModelMeta" alt="" coords="274,1129,418,1148"/>
</map></section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="pyokx.InstrumentSearcher.html" class="btn btn-neutral float-left" title="pyokx.InstrumentSearcher" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="pyokx.low_rest_api.Account.html" class="btn btn-neutral float-right" title="pyokx.low_rest_api.Account" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2024, Ruben Fernandez Carbon.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>